Vehicle Manager API

The Vehicle Manager API is a RESTful Spring Boot application designed to manage vehicle-related operations for businesses or dealerships. It provides a robust backend with secure token-based authentication and supports full CRUD operations across multiple entities.

This project can be used separately or in conjunction with the frontend, for this read the description of the Vehicle Manager Frontend repository

Features

• Vehicle Management: Register and manage details about vehicles in inventory.
• Client Management: Store and retrieve client information for sales and maintenance history.
• Finance Tracking: Track financial records, transactions, and related data.
• Maintenance Logging: Log and manage maintenance records for vehicles.
• Sales Recording: Record vehicle sales, associate them with clients, and manage sales history.
• Secure Authentication: Uses JSON Web Token (JWT) for secure, token-based authentication.

Tech Stack

• Java 17: The application is built using Java version 17.
• Spring Boot 3: Core framework for building the application.
• Spring Data JPA: For data persistence and repository management.
• PostgreSQL: The primary database for the application.
• AWS S3: Used in the prod profile, responsible for storing images in the cloud.
• H2 Database: Used for running automated tests.
• Maven: Dependency management and build tool.
• Spring Security: For handling authentication and authorization.

Prerequisites

Before you begin, ensure you have the following installed on your local machine:

• JDK 17
• Maven 3.x
• PostgreSQL

Getting Started with Docker Compose

Follow these steps to get a local copy of the project up and running with docker compose.

1. Clone the Repository

git clone https://github.com/MatheusSC017/VehicleManager.git
cd VehicleManager

2. Create an environment file (.env)

The application needs an environment file to connect to the database and handle security settings.

SECRET_KEY=<SECRET_KEY>
ALLOWED_ORIGINS=<ALLOWED_ORIGINS>
DB_PASSWORD=<DB_PASSWORD>
AWS_ACCESS_KEY=<AWS_ACCESS_KEY>
AWS_SECRET_KEY=<AWS_SECRET_KEY>
AWS_REGION=<AWS_REGION>
ASW_S3_BUCKET_NAME=<ASW_S3_BUCKET_NAME>

3. Start the application

docker-compose up -d

Getting Started with Local Running

Follow these steps to get a local copy of the project up and running.

1. Clone the Repository

git clone https://github.com/MatheusSC017/VehicleManager.git
cd VehicleManager

2. Profile Configuration

Configure the environment variables according to the configuration file you intend to use, dev or prod.

Step 1: Create the configuration file

Update the file named application-dev.properties inside the directory:

src/main/resources

Step 2: Set up the database

This project uses PostgreSQL as its database.

Make sure you have a PostgreSQL server running.

Create a database, for example: vehicle_manager_db.

Step 3: Add the configuration

Copy the following properties into your application-dev.properties file and replace the placeholder values (<...>) with your actual settings:

# src/main/resources/application-dev.properties

# JWT Secret Key
security.jwt.secret=<YOUR_SECRET_KEY>

# CORS Configuration
cors.config.allowedorigins=*

# PostgreSQL Datasource
spring.datasource.url=jdbc:postgresql://localhost:5432/vehicle_manager_db
spring.datasource.username=<DATABASE_USERNAME>
spring.datasource.password=<DATABASE_PASSWORD>

3. Build the Project

Use Maven to build the project and install dependencies:

mvn clean install

4. Run the Application

You can run the application using the Spring Boot Maven plugin:

mvn spring-boot:run

The application will start on the default port 8080.

Running the Tests

To run the automated tests, use the following Maven command:

mvn test

Running Gatling Tests

To run all the gatlin tests use the command below

for sim in $(find src/test/scala -name "*.scala" | sed 's|src/test/scala/||; s|/|.|g; s|.scala$||'); do
  echo "Running $sim"
  mvn gatling:test -Dgatling.simulationClass=$sim
done

To run individual gatling tests use the command below

mvn gatling:test

or change the values between curly braces in the command below, as explained in group and test

mvn gatling:test -Dgatling.simulationClass=simulations.<group>.<test>

group

• client
• financing
• maintenance
• sale
• vehicle

test

• BasicTest
• LoadTest
• StressTest

Easily Configurable File Storage

In the Control and Services modules, dedicated %File% components were implemented to handle file management operations.

During development, the system is configured to use local storage for file handling.

In production, it integrates with AWS S3, utilizing pre-signed URLs to securely upload and access files.

API Endpoints

The API is structured around REST principles. All endpoints are prefixed with /api.

Authentication

• POST /api/auth/login: Authenticates a user and returns a JWT token.
• POST /api/auth/register: Registers a new user.
• POST /api/auth/refresh: Refresh user authentication and return a new token.

Vehicles

• GET /api/vehicles/images: Get a paginated list of vehicles with filtering options and one image url per record.
• GET /api/vehicles: Get a paginated list of vehicles with filtering options.
• GET /api/vehicles/search: Get a list of vehicles with more basic filtering options.
• GET /api/vehicles/chassi/{chassi}: Get a specific vehicle by its Chassi.
• GET /api/vehicles/{id}: Get a specific vehicle by its ID.
• POST /api/vehicles: Create a new vehicle.
• PUT /api/vehicles/{id}: Update an existing vehicle.
• DELETE /api/vehicles/{id}: Delete a vehicle.

Files

• GET /api/files/{id}: Get a specific file by its ID.
• POST /api/files: Create the files to a specific vehicle and return the pre-signed URLs.
• PUT /api/files/{id}: Create and Delete files to a specific vehicle and return the pre-signed URLs.

Clients

• GET /api/clients: Get a paginated list of clients.
• GET /api/clients/search: Get a list of clients with filtering options.
• GET /api/clients/email/{email}: Get a specific client by its email.
• GET /api/clients/{id}: Get a specific client by its ID.
• POST /api/clients: Create a new client.
• PUT /api/clients/{id}: Update an existing client.
• DELETE /api/clients/{id}: Delete a client.

Sales

• GET /api/sales: Get a paginated list of sales.
• GET /api/sales/vehicle/{id}: Get a list of sales by its vehicle ID.
• GET /api/sales/{id}: Get a specific sale by its ID.
• POST /api/sales: Create a new sale.
• PUT /api/sales/{id}: Update an existing sale.

Maintenances

• GET /api/maintenances: Get a paginated list of maintenances.
• GET /api/maintenances/vehicle/{id}: Get a list of maintenances by its vehicle ID.
• GET /api/maintenances/{id}: Get a specific maintenance by its ID.
• POST /api/maintenances: Create a new maintenance.
• DELETE /api/maintenances/{id}: Update an existing maintenance end date to today, marking the record as deleted.

Financings

• GET /api/financings: Get a paginated list of financings.
• GET /api/financings/{id}: Get a specific financing by its ID.
• GET /api/financings/vehicle/{vehicleId}: Get a specific financing by its vehicle ID and its status must be different from Canceled.
• POST /api/financings: Create a new financing.
• PUT /api/financings/{id}: Update an existing financing.
• PATCH /api/financings/{id}/status: Update an existing financing status.

Authentication

To access protected endpoints, you need to obtain a JWT token by calling the /api/auth/login endpoint with valid credentials. Include this token in the Authorization header of your requests as a Bearer token:

Authorization: Bearer <your-jwt-token>