tecnocrata/bal-reservation

Restaurant Reservation Service

This service is designed to manage Restaurant reservations. It provides functionalities for making, canceling, and listing reservations, as well as user authentication for secure access. The service is built using C# and follows a clean architecture with clearly defined use cases.

Table of Contents

• Restaurant Reservation Service
  • Table of Contents
  • Overview
  • Architecture Overview
  • Use Cases
    • Make Reservation
      • Endpoint
      • Description
      • Handler
      • Validation
      • Example Request
    • Cancel Reservation
      • Endpoint
      • Description
      • Handler
      • Example Request
    • List Reservations
      • Endpoint
      • Description
      • Handler
      • Example Request
    • Get Reservation Details
      • Endpoint
      • Description
      • Handler
      • Example Request
    • User Authentication
      • Endpoint
      • Description
      • Handler
      • Example Request
  • Installation
  • Running the Application
    • Using dotnet run
    • Using Docker Compose
  • Importing Postman Collection
  • Tests

Overview

The Restaurant Reservation Service allows users to manage Restaurant reservations through a set of RESTful API endpoints. The service handles the following scenarios:

• Creating new reservations
• Canceling existing reservations
• Listing all reservations
• Retrieving details of a specific reservation
• Authenticating users

Architecture Overview

The service is built using the principles of Clean Architecture, Domain-Driven Design (DDD), and Slicing Architecture. These architectural patterns ensure that the application is scalable, maintainable, and testable by organizing code into distinct layers with clear responsibilities. A graphical description of how the layers are organized can be found in the Architecture Graph.

Use Cases

Make Reservation

Endpoint

POST /api/reservation

Description

This endpoint allows users to create a new reservation. It validates the reservation details and ensures that the reservation date is within the allowed range.

Handler

MakeCommandHandler

Validation

• Reservation date must be in the future.
• Reservation date must be within 30 days from the current date.
• Reservation time must be between 7:00 PM and 10:00 PM.

Example Request

{
  "id": "unique-reservation-id",
  "date": "2023-08-15T20:00:00Z",
  "guests": 2,
  "name": "John Doe"
}

Cancel Reservation

Endpoint

DELETE /api/reservation/{id}

Description

This endpoint allows users to cancel an existing reservation. It verifies the existence of the reservation before canceling it.

Handler

CancelCommandHandler

Example Request

DELETE /api/reservation/unique-reservation-id

List Reservations

Endpoint

GET /api/reservation

Description

This endpoint retrieves a list of all reservations.

Handler

ListQueryHandler

Example Request

GET /api/reservation

Get Reservation Details

Endpoint

GET /api/reservation/{id}

Description

This endpoint retrieves the details of a specific reservation by its ID.

Handler

DetailQueryHandler

Example Request

GET /api/reservation/unique-reservation-id

User Authentication

Endpoint

POST /authorization/token

Description

This endpoint allows users to authenticate by providing their username and password. It generates a token for authenticated users.

Handler

LoginQueryHandler

Example Request

{
  "username": "testuser",
  "password": "password"
}

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/bal-reservation.git

2. Navigate to the project directory:

   cd bal-reservation

3. Install the required dependencies:

   dotnet restore

Running the Application

Using dotnet run

1. Ensure that you have Docker running on your machine.
2. Start the SQL Server using Docker Compose:

   docker-compose up -d

3. Run the application:

   dotnet run --project src/Api/Api.csproj

4. The application will be available at http://localhost:5001/.

Using Docker Compose

1. Ensure that you have Docker running on your machine.
2. Navigate to the src folder:

   cd src

3. Build and start the services using Docker Compose:

   docker-compose up --build

4. The application will be available at http://localhost:5002/.

Importing Postman Collection

You can import the Postman collection provided in the src folder to test the API endpoints. The collection file is named Bla Restaurant.postman_collection.json.

Tests

Run the tests using the following command:

dotnet test

The project includes comprehensive tests for all handlers to ensure the correctness of the business logic and validate various scenarios.