---

UberWeal SAAS Exercise

Overview

UberWeal SAAS is a ride-hailing application that allows Riders to request drivers for their journeys. The application calculates the ride price based on the nature of the journey and deducts the corresponding funds from the Rider's account.

User Stories

Book a Driver

As a Rider, I want to book a Driver that can take me to my destination, providing an efficient alternative to public transport.

List all my past rides

As a Rider, I would like to l ist all the history of my rides with mention of the respective Drivers, enabling me to track my ride history.

Pricing Rules

• For a trip from Paris to the outside world, the price is 30 euros.
• For a journey from outside to Paris, the price is 0 euro.
• For a journey within the city walls, the price is 10 euros.
• For a trip outside Paris, the price is 50 euros.
• In the first year of use, a Rider pays half the price of the ride.
• If the price was 0€, then a voucher is considered, valid for the next ride.
• If the number of kilometers is less than 5 km, there is a 5-euro discount.

System Overview

Sequence Diagram

sequenceDiagram
  participant Rider
  participant Controller
  participant CommandHandler
  participant Gateway
  participant Ride

  Rider ->> Controller: Request to book a trip or journey
  Controller ->> CommandHandler: Handle book ride command
  CommandHandler ->> Gateway: Calculate ride price based on ride type
  Gateway ->> Ride: Create ride entity with calculated price
  Ride -->> Gateway: Confirm ride creation
  Gateway -->> CommandHandler: Return ride details with price
  CommandHandler -->> Controller: Return response with price
  Controller -->> Rider: Display booking confirmation with price

Loading

Implementation Details

Project Structure

The project follows the Clean Architecture principles, organizing code into distinct layers for improved maintainability and testability.

src
└── main
    └── java
        └── com.samir.uberweal
            ├── adapters
            ├── application
            ├── domain
            └── infrastructure

• adapters: Contains the delivery mechanisms like controllers, presenters, and gateways.
• application: Contains use case implementations and business rules orchestration.
• domain: Holds the business entities and domain specific logic.
• infrastructure: Deals with external concerns, such as databases or external services.

Dependencies

The project uses Maven as the build tool.

Maven Wrapper

What is Maven Wrapper?

Maven Wrapper is a mechanism that allows a Maven project to be built, executed, and developed with a predefined Maven version. This means users don't have to install Maven globally on their systems.

Using Maven Without Installation

1. Navigate to the project's root directory in the terminal.

2. Run Maven commands using the wrapper. For example, to build and run the Spring project:

• On Unix-based systems:

  ./mvnw spring-boot:run

• On Windows:

  .\mvnw.cmd spring-boot:run

Alternatively, you can build and package the project into a JAR file and then run it using java -jar:

./mvnw clean package
java -jar target/UberWeal-0.0.1-SNAPSHOT.jar

On Windows:

.\mvnw.cmd clean package
java -jar target\UberWeal-0.0.1-SNAPSHOT.jar

These commands use the Maven Wrapper (mvnw or mvnw.cmd) to build and run the Spring project. The spring-boot:run goal is specific to Spring Boot applications and simplifies the process by automatically packaging and running the application.

Testing

Test cases are provided to ensure the correctness of the implemented use cases.

Running the Tests

To run the tests using Maven, execute the following command:

./mvnw test

If you are on Windows, you can use the following command:

.\mvnw.cmd test

---