kacpermekarski / geolocator

REST API which stores location based on IP or URL.

Description of geolocator

It's REST API which locates and stores location basing on IP or URL.

Code style

Rubocop

Built with:

• Ruby 3.0.3
• Ruby on Rails 7.0.8
• PostgreSQL 14.4
• Redis 7.2-alpine
• Docker 24.0.7

Installing

$ git clone https://github.com/KacperMekarski/geolocator.git

$ cd geolocator

Download master.key file and place it in config directory. File was given in email with link to this repo)

$ docker compose build

$ docker compose run web rake db:setup

$ docker compose up

You can run tests with:
$ docker compose run web bundle exec rspec spec

Stop application with:
$ docker compose down

API Documentation

Sorry for such documentation, I know it should be done with swagger or something but I didn't have time for it.

IP

Provide geolocation data based on IP address:
GET /api/ip_addresses/20.199.210.196

Delete geolocation data based on IP address:
DELETE /api/ip_addresses/20.199.210.196

Add geolocation data based on IP address:
POST /api/ip_addresses, body: { 'ip': '20.199.210.196' }

URL

Please note URL should be encoded.

Provide geolocation data based on URL address:
GET /api/domains?url=https://google.com

Delete geolocation data based on URL address:
DELETE /api/domains?url=https://google.com

Add geolocation data based on URL address:
POST /api/domains, body: { 'url': 'https://google.com' }

Author

• Kacper Mekarski

License

MIT © Kacper Mękarski