feat: 시외버스 API 구현

src/main/java/in/koreatech/koin/domain/bus/controller/BusApi.java

@@ -5,6 +5,8 @@
 import org.springframework.web.bind.annotation.RequestParam;
 
 import in.koreatech.koin.domain.bus.dto.BusRemainTimeResponse;
+import in.koreatech.koin.domain.bus.model.enums.BusStation;
+import in.koreatech.koin.domain.bus.model.enums.BusType;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.media.Content;
@@ -25,8 +27,8 @@ public interface BusApi {
     @Operation(summary = "이번 / 다음 버스 남은 시간 조회")
     @GetMapping("/bus")
     ResponseEntity<BusRemainTimeResponse> getBusRemainTime(
-        @Parameter(description = "버스 종류(city, express, shuttle, commuting)") @RequestParam(value = "bus_type") String busType,
-        @Parameter(description = "koreatech, station, terminal") @RequestParam String depart,
-        @Parameter(description = "koreatech, station, terminal") @RequestParam String arrival
+        @Parameter(description = "버스 종류(city, express, shuttle, commuting)") @RequestParam(value = "bus_type") BusType busType,
+        @Parameter(description = "koreatech, station, terminal") @RequestParam BusStation depart,
+        @Parameter(description = "koreatech, station, terminal") @RequestParam BusStation arrival
     );
 }

src/main/java/in/koreatech/koin/domain/bus/controller/BusController.java

@@ -6,6 +6,8 @@
 import org.springframework.web.bind.annotation.RestController;
 
 import in.koreatech.koin.domain.bus.dto.BusRemainTimeResponse;
+import in.koreatech.koin.domain.bus.model.enums.BusStation;
+import in.koreatech.koin.domain.bus.model.enums.BusType;
 import in.koreatech.koin.domain.bus.service.BusService;
 import lombok.RequiredArgsConstructor;
 
@@ -17,9 +19,9 @@ public class BusController implements BusApi {
 
     @GetMapping("/bus")
     public ResponseEntity<BusRemainTimeResponse> getBusRemainTime(
-        @RequestParam(value = "bus_type") String busType,
-        @RequestParam String depart,
-        @RequestParam String arrival
+        @RequestParam(value = "bus_type") BusType busType,
+        @RequestParam BusStation depart,
+        @RequestParam BusStation arrival
     ) {
         BusRemainTimeResponse busRemainTime = busService.getBusRemainTime(busType, depart, arrival);
         return ResponseEntity.ok().body(busRemainTime);

src/main/java/in/koreatech/koin/domain/bus/controller/BusStationEnumConverter.java

@@ -0,0 +1,19 @@
+package in.koreatech.koin.domain.bus.controller;
+
+import java.util.Arrays;
+
+import org.springframework.core.convert.converter.Converter;
+
+import in.koreatech.koin.domain.bus.model.enums.BusStation;
+import in.koreatech.koin.global.domain.upload.exception.ImageUploadDomainNotFoundException;
+
+public class BusStationEnumConverter implements Converter<String, BusStation> {
+
+    @Override
+    public BusStation convert(String source) {
+        return Arrays.stream(BusStation.values())
+            .filter(it -> it.name().equalsIgnoreCase(source))
+            .findAny()
+            .orElseThrow(() -> ImageUploadDomainNotFoundException.withDetail("source: " + source));
+    }
+}

src/main/java/in/koreatech/koin/domain/bus/controller/BusTypeEnumConverter.java

@@ -0,0 +1,19 @@
+package in.koreatech.koin.domain.bus.controller;
+
+import java.util.Arrays;
+
+import org.springframework.core.convert.converter.Converter;
+
+import in.koreatech.koin.domain.bus.model.enums.BusType;
+import in.koreatech.koin.global.domain.upload.exception.ImageUploadDomainNotFoundException;
+
+public class BusTypeEnumConverter implements Converter<String, BusType> {
+
+    @Override
+    public BusType convert(String source) {
+        return Arrays.stream(BusType.values())
+            .filter(it -> it.name().equalsIgnoreCase(source))
+            .findAny()
+            .orElseThrow(() -> ImageUploadDomainNotFoundException.withDetail("source: " + source));
+    }
+}

src/main/java/in/koreatech/koin/domain/bus/dto/BusRemainTimeResponse.java

@@ -8,8 +8,8 @@
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
 
 import in.koreatech.koin.domain.bus.model.BusRemainTime;
+import in.koreatech.koin.domain.bus.model.city.CityBusRemainTime;
 import in.koreatech.koin.domain.bus.model.enums.BusType;
-import in.koreatech.koin.domain.bus.model.CityBusRemainTime;
 
 @JsonNaming(SnakeCaseStrategy.class)
 public record BusRemainTimeResponse(

src/main/java/in/koreatech/koin/domain/bus/dto/ExpressBusRemainTime.java

@@ -0,0 +1,17 @@
+package in.koreatech.koin.domain.bus.dto;
+
+import java.time.LocalTime;
+
+import in.koreatech.koin.domain.bus.model.BusRemainTime;
+import lombok.Getter;
+
+@Getter
+public class ExpressBusRemainTime extends BusRemainTime {
+
+    private final String busType;
+
+    public ExpressBusRemainTime(LocalTime busArrivalTime, String busType) {
+        super(busArrivalTime);
+        this.busType = busType;
+    }
+}

src/main/java/in/koreatech/koin/domain/bus/dto/ExpressBusTimeTable.java

@@ -0,0 +1,29 @@
+package in.koreatech.koin.domain.bus.dto;
+
+import static java.time.format.DateTimeFormatter.ofPattern;
+
+import java.time.LocalTime;
+
+import in.koreatech.koin.domain.bus.model.express.ExpressBusCacheInfo;
+import in.koreatech.koin.domain.bus.model.express.OpenApiExpressBusArrival;
+
+public record ExpressBusTimeTable(
+    LocalTime departure,
+    LocalTime arrival,
+    int charge
+) {
+
+    public static ExpressBusTimeTable from(OpenApiExpressBusArrival openApiExpressBusArrival) {
+        LocalTime departure = LocalTime.parse(openApiExpressBusArrival.depPlandTime(), ofPattern("yyyyMMddHHmm"));
+        LocalTime arrival = LocalTime.parse(openApiExpressBusArrival.arrPlandTime(), ofPattern("yyyyMMddHHmm"));
+        int charge = openApiExpressBusArrival.charge();
+        return new ExpressBusTimeTable(departure, arrival, charge);
+    }
+
+    public static ExpressBusTimeTable from(ExpressBusCacheInfo expressBusCacheInfo) {
+        LocalTime departure = expressBusCacheInfo.departureTime();
+        LocalTime arrival = expressBusCacheInfo.arrivalTime();
+        int charge = expressBusCacheInfo.charge();
+        return new ExpressBusTimeTable(departure, arrival, charge);
+    }
+}

src/main/java/in/koreatech/koin/domain/bus/model/BusRemainTime.java

@@ -27,13 +27,13 @@ public Long getRemainSeconds(Clock clock) {
         return null;
     }
 
-    public static BusRemainTime from(String arrivalTime) {
+    public static BusRemainTime of(String arrivalTime) {
         return builder()
             .busArrivalTime(toLocalTime(arrivalTime))
             .build();
     }
 
-    public static BusRemainTime from(Long remainTime, LocalTime updatedAt) {
+    public static BusRemainTime of(Long remainTime, LocalTime updatedAt) {
         return builder()
             .busArrivalTime(updatedAt.plusSeconds(remainTime))
             .build();
@@ -59,11 +59,13 @@ public int hashCode() {
 
     @Override
     public boolean equals(Object o) {
-        if (this == o)
+        if (this == o) {
             return true;
-        if (o == null || getClass() != o.getClass())
+        }
+        if (o == null || getClass() != o.getClass()) {
             return false;
-        BusRemainTime that = (BusRemainTime)o;
+        }
+        BusRemainTime that = (BusRemainTime) o;
         return Objects.equals(busArrivalTime, that.busArrivalTime);
     }
 

src/main/java/in/koreatech/koin/domain/bus/model/CityBusArrival.java → src/main/java/in/koreatech/koin/domain/bus/model/city/CityBusArrival.java

@@ -1,4 +1,4 @@
-package in.koreatech.koin.domain.bus.model;
+package in.koreatech.koin.domain.bus.model.city;
 
 import lombok.Builder;
 
@@ -13,10 +13,5 @@ public record CityBusArrival(
     String routetp, // 노선 유형, "일반 버스"
     String vehicletp // 차량 유형 (저상버스), "일반차량"
 ) {
-    public static CityBusArrival getEmpty(String nodeid) {
-        return builder()
-            .nodeid(nodeid)
-            .arrtime(-1L)
-            .build();
-    }
+
 }

src/main/java/in/koreatech/koin/domain/bus/model/redis/CityBusCache.java → src/main/java/in/koreatech/koin/domain/bus/model/city/CityBusCache.java

@@ -1,4 +1,4 @@
-package in.koreatech.koin.domain.bus.model.redis;
+package in.koreatech.koin.domain.bus.model.city;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -21,30 +21,26 @@ public class CityBusCache {
     @Id
     private String id;
 
-    private final List<BusCache> busInfos = new ArrayList<>();
+    private final List<CityBusCacheInfo> busInfos = new ArrayList<>();
 
     @TimeToLive(unit = TimeUnit.MINUTES)
     private final Long expiration;
 
     @Builder
-    private CityBusCache(String id, List<BusCache> busInfos, Long expiration) {
+    private CityBusCache(String id, List<CityBusCacheInfo> busInfos, Long expiration) {
         this.id = id;
         this.busInfos.addAll(busInfos);
         this.expiration = expiration;
     }
 
-    public static CityBusCache create(String nodeId, List<BusCache> busInfos) {
+    public static CityBusCache of(String nodeId, List<CityBusCacheInfo> busInfos) {
         return CityBusCache.builder()
             .id(nodeId)
             .busInfos(busInfos)
             .expiration(CACHE_EXPIRE_MINUTE)
             .build();
     }
 
-    public static long getCacheExpireMinute() {
-        return CACHE_EXPIRE_MINUTE;
-    }
-
     public static long getCacheExpireSeconds() {
         return CACHE_EXPIRE_SECONDS;
     }

src/main/java/in/koreatech/koin/domain/bus/model/city/CityBusCacheInfo.java

@@ -0,0 +1,26 @@
+package in.koreatech.koin.domain.bus.model.city;
+
+import java.time.LocalDateTime;
+import java.time.LocalTime;
+
+import in.koreatech.koin.domain.bus.model.BusRemainTime;
+
+public record CityBusCacheInfo(
+    Long busNumber,
+    LocalTime remainTime
+) {
+
+    /**
+     * <pre>
+     * 남은 시간 = (캐시 저장 시각 + 저장된 남은시간) - 현재시각
+     * {@link BusRemainTime#getRemainSeconds}에서는 남은 시간을 (저장된 남은시간 - 현재시각)으로 계산중
+     * 학교 버스는 도착 시간을 저장하고, 시내버스는 남은 시간만을 저장하므로
+     * Redis에 저장할때 (캐시 저장 시각 + 남은시간)으로 저장하여 통일시켜줌</pre>
+     * */
+    public static CityBusCacheInfo of(CityBusArrival busArrivalInfo, LocalDateTime updatedAt) {
+        return new CityBusCacheInfo(
+            busArrivalInfo.routeno(),
+            updatedAt.plusSeconds(busArrivalInfo.arrtime()).toLocalTime()
+        );
+    }
+}

src/main/java/in/koreatech/koin/domain/bus/model/CityBusRemainTime.java → src/main/java/in/koreatech/koin/domain/bus/model/city/CityBusRemainTime.java

@@ -1,23 +1,24 @@
-package in.koreatech.koin.domain.bus.model;
+package in.koreatech.koin.domain.bus.model.city;
 
 import java.time.LocalTime;
 import java.util.Objects;
 
-import in.koreatech.koin.domain.bus.model.redis.BusCache;
+import in.koreatech.koin.domain.bus.model.BusRemainTime;
 import lombok.Getter;
 import lombok.experimental.SuperBuilder;
 
 @Getter
 @SuperBuilder
 public class CityBusRemainTime extends BusRemainTime {
+
     private final Long busNumber;
 
     public CityBusRemainTime(Long busNumber, LocalTime busArrivalTime) {
         super(busArrivalTime);
         this.busNumber = busNumber;
     }
 
-    public static CityBusRemainTime from(BusCache busInfo) {
+    public static CityBusRemainTime from(CityBusCacheInfo busInfo) {
         return builder()
             .busNumber(busInfo.busNumber())
             .busArrivalTime(busInfo.remainTime())
@@ -31,11 +32,13 @@ public int hashCode() {
 
     @Override
     public boolean equals(Object o) {
-        if (this == o)
+        if (this == o) {
             return true;
-        if (o == null || getClass() != o.getClass())
+        }
+        if (o == null || getClass() != o.getClass()) {
             return false;
-        CityBusRemainTime that = (CityBusRemainTime)o;
+        }
+        CityBusRemainTime that = (CityBusRemainTime) o;
         return Objects.equals(getBusArrivalTime(), that.getBusArrivalTime())
             && Objects.equals(busNumber, that.busNumber);
     }

src/main/java/in/koreatech/koin/domain/bus/model/enums/BusApiType.java

@@ -7,16 +7,10 @@
 
 @Getter
 public enum BusApiType {
-    CITY("cityBusOpenApiClient"),
-    EXPRESS("intercityBusOpenApiClient"),
+    CITY,
+    EXPRESS,
     ;
 
-    private final String value;
-
-    BusApiType(String bean) {
-        this.value = bean;
-    }
-
     public static BusApiType from(BusType value) {
         return Arrays.stream(values())
             .filter(busApiType -> busApiType.toString().equalsIgnoreCase(value.toString()))

src/main/java/in/koreatech/koin/domain/bus/model/enums/BusStation.java

@@ -3,6 +3,8 @@
 import java.util.Arrays;
 import java.util.List;
 
+import com.fasterxml.jackson.annotation.JsonCreator;
+
 import in.koreatech.koin.domain.bus.exception.BusStationNotFoundException;
 import lombok.Getter;
 
@@ -21,6 +23,7 @@ public enum BusStation {
         this.node = node;
     }
 
+    @JsonCreator
     public static BusStation from(String busStationName) {
         return Arrays.stream(values())
             .filter(busStation -> busStation.name().equalsIgnoreCase(busStationName))

src/main/java/in/koreatech/koin/domain/bus/model/enums/BusType.java

@@ -2,6 +2,8 @@
 
 import java.util.Arrays;
 
+import com.fasterxml.jackson.annotation.JsonCreator;
+
 import in.koreatech.koin.domain.bus.exception.BusTypeNotFoundException;
 import lombok.Getter;
 
@@ -13,6 +15,7 @@ public enum BusType {
     COMMUTING,
     ;
 
+    @JsonCreator
     public static BusType from(String busTypeName) {
         return Arrays.stream(values())
             .filter(busType -> busType.name().equalsIgnoreCase(busTypeName))