RESTful API for managing ride information

# build docker container
make build

# start docker container
make up

# run migrations
make migrate

# create super user
make superuser

# serve locally on http://localhost:8000
# CTRL-C will stop the development server
make serve

# stop docker container
make down

Available as both SwaggerUI (http://localhost:8000/api/schema/swagger-ui/) and Redoc (http://localhost:8000/api/schema/redoc/)

Run make report to get count of trips that took more than one hour, grouped by month and driver

The complete SQL query is below for reference

SELECT
    TO_CHAR(ride.pickup_time, 'YYYY-MM') AS month,
    CONCAT(driver.first_name, ' ', LEFT(driver.last_name, 1), '.') AS name,
    COUNT(*) AS ride_count
FROM
    rides_ride ride
JOIN
    users_user driver ON ride.driver_id = driver.id
JOIN
    rides_rideevent pickup_event ON ride.id = pickup_event.ride_id AND pickup_event.description = 'Status changed to pickup'
JOIN
    rides_rideevent dropoff_event ON ride.id = dropoff_event.ride_id AND dropoff_event.description = 'Status changed to dropoff'
WHERE
    EXTRACT(HOUR FROM AGE(dropoff_event.created_at, pickup_event.created_at)) > 1
GROUP BY
    month,
    name

Some notes on design decisions

• Defined custom user because modifying default user after migrations have been created is a royal pain
• Extended AbstractBaseUser instead of AbstractUser in case the method of authentication changes

• Set the default on_delete behavior to models.SET_NULL out of convenience
• Used DecimalField versus FloatField (as specified in the requirements) since decimal math is more precise compared to float math
  • Based on whether we are reading or writing more frequently to the database, "good enough" float math may be worth the performance benefits
• Chose Postgres over MySQL because Postgres offers geospatial extensions
• Calculated distance to pickup using the Haversine distance due to simpler math. If greater accuracy is needed, worth looking into proper geodesic distance using Vincenty algorithm

Miscellaneous notes and features to be implemented

• Use django-environ to load settings from .env based on environment
• Disable django-silk or require authentication
• Validate user phone numbers as E.164
• Lint with flake8
• Write unit tests