Merge pull request #3 from VishalMCF/feature/ride-sharing

finished machine coding a ride amount calculdator app

Author: VishalMCF

src/main/java/com/gatomalvado/ridesharing/ConstantConfig.java

@@ -0,0 +1,12 @@
+package com.gatomalvado.ridesharing;
+
+public class ConstantConfig {
+    public static double amountCharged = 20.0;
+
+    public static final String MSG_CODE1 = "Ride could not be found for the id provided => ";
+    public static final String MSG_CODE2 = "Seats can only be between 1 to 4";
+    public static final String MSG_CODE3 = "Destination must be greater than origin";
+    public static final String MSG_CODE4 = "Destination and origin must be greater than 0";
+    public static final String MSG_CODE5 = "Cannot withdraw a ride which is not in a booked status, id -> ";
+    public static final String MSG_CODE6 = "";
+}

src/main/java/com/gatomalvado/ridesharing/Main.java

@@ -0,0 +1,38 @@
+package com.gatomalvado.ridesharing;
+
+import java.sql.DriverManager;
+
+import com.gatomalvado.ridesharing.model.BookedRide;
+import com.gatomalvado.ridesharing.model.Driver;
+import com.gatomalvado.ridesharing.model.Rider;
+import com.gatomalvado.ridesharing.model.enums.UserType;
+import com.gatomalvado.ridesharing.orchestrator.RideManager;
+import com.gatomalvado.ridesharing.strategy.CostCalculatorFactory;
+
+public class Main {
+    public static void main(String[] args){
+        Rider rider1 = new Rider("r1","rider1", "email1");
+        Rider rider2 = new Rider("r2","rider2", "email2");
+
+        Driver driver1 = new Driver("d1","driver1", "email3");
+        Driver driver2 = new Driver("d2","driver2", "email4");
+        Driver driver3 = new Driver("d3","driver3", "email5");
+        Driver driver4 = new Driver("d4","driver4", "email6");
+
+        CostCalculatorFactory costCalculatorFactory = new CostCalculatorFactory();
+        RideManager riderManager  = new RideManager(costCalculatorFactory);
+
+        riderManager.addRider(rider1);
+        riderManager.addRider(rider2);
+
+        riderManager.addDriver(driver1);
+        riderManager.addDriver(driver2);
+        riderManager.addDriver(driver3);
+        riderManager.addDriver(driver4);
+
+        // take input
+
+        // create ride
+    }
+
+}

src/main/java/com/gatomalvado/ridesharing/README.md

@@ -0,0 +1,48 @@
+# Ride Sharing Application Design
+
+## Problem Definition
+Design a Ride sharing application where drivers can offer rides (origin, destination, no of seats), and any rider can request rides (origin, destination, no of seats). The application should calculate the ride amount charged for a given ride based on distance and the number of seats. The algorithm for calculating ride amount is as follows:
+1. When the ride closes, show the amount charged to the rider.
+2. Ride amount if No of seats >= 2: No of kilometers * No of seats * 0.75 * Amount Charged per KM
+3. Ride amount if No of seats = 1: No of kilometers * Amount Charged per KM
+
+## Assumptions
+1. Amount charged per KM = 20
+2. No of Kilometers = destination - origin
+3. All values are integers
+
+## Test Cases
+- A requesting for ride R1
+    - **INPUT:** A requests 50, 60, 1
+    - **OUTPUT:** Ride Amount: 10 * 20 (Amount/Km) = 200
+
+- A requesting for ride R1
+    - **INPUT:** A requests 50, 60, 2
+    - **OUTPUT:** Ride Amount: 10 * 2 * 0.75 * 20 (Amount/Km) = 300
+
+## Bonus
+- Upgrade the rider to a preferred rider if he has done more than 10 rides.
+- Preferred Rider amount if No of seats >= 2: No of kilometers * No of seats * 0.5 * Amount Charged per KM
+- Preferred Ride amount if No of seats = 1: No of kilometers * Amount Charged per KM * 0.75
+
+## Functionalities Expected
+- Add Driver(name)
+- Add Rider(name)
+- Create Ride (id, origin, destination, no of seats)
+- Create/Update Ride (id, origin, destination, no of seats)
+- Withdraw Ride (id)
+- Close ride and return ride amount charged
+
+## Expectations
+1. Create the sample data yourself. You can put it into a file, test case, or main driver program itself.
+2. The code should be demo-able. Either by using the main driver program or test cases.
+3. The code should be modular with basic OO design.
+4. The code should be extensible with interfaces and contracts between different methods.
+5. The code should handle edge cases properly and fail gracefully.
+6. The code should be legible, readable, and DRY.
+7. Database integration is not required.
+
+## Guidelines
+1. Do not access the internet for anything EXCEPT syntax.
+2. You are free to use the language and IDE of your choice.
+3. The entire code should be your own.

src/main/java/com/gatomalvado/ridesharing/exception/InvalidInputException.java

@@ -0,0 +1,8 @@
+package com.gatomalvado.ridesharing.exception;
+
+public class InvalidInputException extends RuntimeException {
+
+    public InvalidInputException(String message) {
+        super(message);
+    }
+}

src/main/java/com/gatomalvado/ridesharing/model/BookedRide.java

@@ -0,0 +1,29 @@
+package com.gatomalvado.ridesharing.model;
+
+import java.util.UUID;
+
+import com.gatomalvado.ridesharing.model.enums.RideStatus;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@AllArgsConstructor
+@NoArgsConstructor
+public class BookedRide {
+
+    private Rider rider;
+    private Driver driver;
+    private Ride rideDetails;
+    private String id;
+    private RideStatus rideStatus;
+
+    public BookedRide(Rider rider, Driver driver, Ride rideDetails, RideStatus rideStatus) {
+        this.rider = rider;
+        this.driver = driver;
+        this.rideDetails = rideDetails;
+        this.id = UUID.randomUUID().toString();
+        this.rideStatus = rideStatus;
+    }
+}

src/main/java/com/gatomalvado/ridesharing/model/Driver.java

@@ -0,0 +1,22 @@
+package com.gatomalvado.ridesharing.model;
+
+import com.gatomalvado.ridesharing.model.enums.UserType;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+
+@Data
+@AllArgsConstructor
+@EqualsAndHashCode(callSuper = true)
+public class Driver extends UserDetails{
+    private UserType userType;
+    private Boolean isFree;
+
+    public Driver(String userId, String name, String email) {
+        super(userId, name, email);
+        this.userType = UserType.DRIVER;
+        this.isFree = true;
+    }
+}

src/main/java/com/gatomalvado/ridesharing/model/Ride.java

@@ -0,0 +1,14 @@
+package com.gatomalvado.ridesharing.model;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class Ride {
+    private Double origin;
+    private Double destination;
+    private Integer noOfSeats;
+}

src/main/java/com/gatomalvado/ridesharing/model/Rider.java

@@ -0,0 +1,21 @@
+package com.gatomalvado.ridesharing.model;
+
+import com.gatomalvado.ridesharing.model.enums.UserType;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+
+@EqualsAndHashCode(callSuper = true)
+@AllArgsConstructor
+@Data
+public class Rider extends UserDetails {
+    private UserType userType;
+    private boolean preferredRider;
+
+    public Rider(String userId, String name, String email) {
+        super(userId, name, email);
+        this.userType = UserType.RIDER;
+    }
+}

src/main/java/com/gatomalvado/ridesharing/model/UserDetails.java

@@ -0,0 +1,14 @@
+package com.gatomalvado.ridesharing.model;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class UserDetails {
+    private String userId;
+    private String name;
+    private String email;
+}

src/main/java/com/gatomalvado/ridesharing/model/enums/RideStatus.java

@@ -0,0 +1,16 @@
+package com.gatomalvado.ridesharing.model.enums;
+
+import lombok.Getter;
+
+@Getter
+public enum RideStatus {
+    BOOKED("booked"),
+    WITHDRAWN("withdrawn"),
+    CLOSED("closed");
+
+    private String name;
+
+    RideStatus(String name) {
+        this.name = name;
+    }
+}