Geolocation API

Overview

This is a simple Ruby on Rails API that stores and retrieves geolocation data based on IP address or URL. The API uses ipstack as the geolocation service provider, but the implementation is abstracted in a way that allows for easy swapping of the service provider in the future. The API is secured with token-based authentication and follows the JSON API standard.

Features

• Store Geolocation Data: Fetch and store geolocation data using an IP address or URL.
• Retrieve Geolocation Data: Retrieve stored geolocation data by ID.
• Delete Geolocation Data: Delete stored geolocation data by ID.
• Token-based Authentication: All endpoints are secured and require a valid API token.
• Service Provider Abstraction: The geolocation service is abstracted for easy swapping of providers.
• JSON API: Input and output are handled using JSON.

Getting Started

Prerequisites

• Docker and Docker Compose
• Ruby 3.3.4
• Rails 8
• An API key from ipstack

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/geolocation_api.git
   cd geolocation_api
   bundle
   ./bin/dev

2. Create a .env file in the root directory and add your API keys:

IPSTACK_API_KEY=your_ipstack_api_key
API_TOKEN=your_secure_api_token
SECRET_KEY_BASE=<secret_key_base>
RAILS_MASTER_KEY=<rails key>

3.Test the application by running the test suite:

bundle exec rails test

4. Curl the API to create a new geolocation record:

curl -X POST http://localhost:3000/v1/geolocations \
    -H "Authorization: your_secure_api_token" \
    -H "Content-Type: application/json" \
    -d '{"geolocation": {"ip_or_url": "134.201.250.155"}}'

5. Delete the geolocation record:

### Docker

1. Build the Docker image:

```bash
docker build -t geoloc_api .

2. Start the application:

➜  docker run -d -p 80:80 -v --env-file=.env  --name geoloc_api geoloc_api

3. Run the tests:
```bash
docker exec -it geoloc_api bin/rails test

4. Test with curl and create a new geolocation record:

curl -X POST http://localhost/v1/geolocations \
    -H "Authorization: your_secure_api_token" \
    -H "Content-Type: application/json" \
    -d '{"geolocation": {"ip_or_url": "134.201.250.155"}}'

API Documentation

Usage

The API has the following endpoints:

• Create Geolocation Data

  • POST /v1/geolocations

  • Body:

    {
      "geolocation": {
        "ip_or_url": "134.201.250.155"
      }
    }

  • Headers: Authorization: your_secure_api_token

• Retrieve Geolocation Data

  • GET /v1/geolocations/:id
  • Example: GET /v1/geolocations/1

• Delete Geolocation Data

  • DELETE /v1/geolocations/:id
  • Headers: Authorization: your_secure_api_token