Andrealf02 / code-challenge-hotel

Reservation System

Reservation System

This project is a reservation management application that allows users to make and manage accommodation reservations. The application includes features such as reservation statistics calculation and profit maximization.

Table of Contents

1. Project Structure
2. Technologies Used
3. Methodologies
4. How to Run the Application
5. How to Deploy with Docker
6. How to Run Tests
7. API Documentation
8. Contributions
9. License

Project Structure

The project follows a hexagonal architecture (Ports and Adapters) and is designed under the principles of Domain-Driven Design (DDD) with main folders for different components:

• src/main/java/org/main/booking: Contains the application source code.
  • application: Includes application logic and services.
  • domain: Defines the domain model and entities.
  • adapter: Contains application adapters, such as controllers and repositories.
  • config: Application configurations.
• src/test: Contains unit tests.
• src/main/resources: Contains resources, such as configuration files.

Technologies Used

• Java
• Spring Boot
• Lombok

Methodologies

The development of this project follows the following methodologies:

1. Agile Methodology (Scrum): Agile practices have been employed for iterative and incremental development, allowing adaptation to changes and continuous delivery of value to the client.

2. Test-Driven Development (TDD): TDD practices have been followed to ensure adequate test coverage and improve code quality.

3. The hexagonal architecture: also known as Ports and Adapters, organizes a system into independent layers, allowing the separation of business logic from external code, thereby facilitating adaptability and testing.

4. Domain-Driven Design (DDD): is a software design methodology that focuses on understanding and modeling the problem domain to develop more effective solutions aligned with business needs.

How to Run the Application

1. Clone the repository: git clone https://github.com/your-username/code-challenge-hotel
2. Navigate to the project directory: cd stayForLong
3. Run the application: ./mvnw spring-boot:run

The application will be available at http://localhost:8080.

API Documentation

Swagger UI

The Swagger UI is available at http://localhost:8080/swagger-ui.html. You can use this interface to visualize and interact with the API endpoints.

Swagger JSON

The Swagger JSON file, which describes the API, can be found at http://localhost:8080/v2/api-docs.

Reservation Endpoints

Calculate Booking Stats

• Endpoint: POST /stats
• This endpoint calculates and returns the average, minimum, and maximum profit per night based on the provided booking requests.

Example Request:

[
  {
    "request_id": "booking_request_1",
    "check_in": "2022-03-01",
    "nights": 3,
    "selling_rate": 150,
    "margin": 15
  },
  {
    "request_id": "booking_request_2",
    "check_in": "2022-03-05",
    "nights": 2,
    "selling_rate": 120,
    "margin": 10
  }
] 

Example Response:

{
  "avg_night": 12.67,
  "min_night": 10.5,
  "max_night": 15
}

Maximize Profits

• Endpoint: POST /maximize
• This endpoint identifies the best combination of booking requests to maximize total profits.

Example Request:

[
  {
    "request_id": "booking_request_1",
    "check_in": "2022-03-01",
    "nights": 3,
    "selling_rate": 150,
    "margin": 15
  },
  {
    "request_id": "booking_request_2",
    "check_in": "2022-03-05",
    "nights": 2,
    "selling_rate": 120,
    "margin": 10
  }
]

Example Response:

{
  "request_ids": ["booking_request_1", "booking_request_2"],
  "total_profit": 78,
  "avg_night": 13,
  "min_night": 12,
  "max_night": 15
}

How to Run Tests

To run tests, use the following command:

./mvn test