feat: Routes Endpoint

.env.template

@@ -0,0 +1,5 @@
+# =============================
+# OTP API
+# =============================
+
+OTP_API_URL=http://localhost:8080

.gitignore

@@ -1,7 +1,7 @@
 # compiled output
-/dist
-/node_modules
-/build
+dist/
+node_modules/
+build/
 
 # Logs
 logs

package.json

@@ -20,9 +20,12 @@
     "test:e2e": "jest --config ./test/jest-e2e.json"
   },
   "dependencies": {
+    "@nestjs/axios": "^3.0.3",
     "@nestjs/common": "^10.0.0",
+    "@nestjs/config": "^3.2.3",
     "@nestjs/core": "^10.0.0",
     "@nestjs/platform-express": "^10.0.0",
+    "axios": "^1.7.7",
     "express": "^4.19.2",
     "reflect-metadata": "^0.2.0",
     "rxjs": "^7.8.1"

src/app.module.ts

@@ -1,12 +1,15 @@
 import { Module } from '@nestjs/common';
-import { RouteController } from './route/route.controller';
-import { RouteModule } from './route/route.module';
 import { OtpController } from './otp/otp.controller';
 import { OtpModule } from './otp/otp.module';
+import { RoutesController } from './routes/routes.controller';
+import { RoutesModule } from './routes/routes.module';
+import { RoutesService } from './routes/routes.service';
+import { HttpModule } from '@nestjs/axios';
+import { ConfigModule } from '@nestjs/config';
 
 @Module({
-  imports: [RouteModule, OtpModule],
-  controllers: [RouteController, OtpController],
-  providers: [],
+  imports: [OtpModule, RoutesModule, HttpModule, ConfigModule.forRoot()],
+  controllers: [OtpController, RoutesController],
+  providers: [RoutesService],
 })
 export class AppModule {}

src/common/utils/request.util.ts

@@ -0,0 +1,16 @@
+import { HttpService } from '@nestjs/axios';
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { firstValueFrom } from 'rxjs';
+import { map } from 'rxjs/operators';
+
+export const GET = async <T>(
+  httpService: HttpService,
+  url: string,
+  config?: AxiosRequestConfig,
+): Promise<T> => {
+  return await firstValueFrom(
+    httpService
+      .get(url, config)
+      .pipe(map((response: AxiosResponse<T>) => response.data)),
+  );
+};

src/routes/dto/get-routes.dto.ts

@@ -0,0 +1,9 @@
+import { Route, TripGeometry } from '../interfaces/route.interface';
+
+export class GetRoutesDto {
+  [routeId: Route['id']]: {
+    Route: Route['longName'];
+    Outbound: TripGeometry['points'];
+    Inbound: TripGeometry['points'];
+  };
+}

src/routes/interfaces/route.interface.ts

@@ -0,0 +1,20 @@
+export type Route = {
+  id: string;
+  shortName: string;
+  longName: string;
+  mode: string;
+  color: string;
+  agencyName: string;
+}
+
+export type RouteTrip = {
+  id: string;
+  serviceId: string;
+  shapeId: string;
+  direction: number;
+}
+
+export type TripGeometry = {
+  points: string;
+  length: number;
+}

src/route/route.controller.spec.ts → src/routes/routes.controller.spec.ts

@@ -1,15 +1,15 @@
 import { Test, TestingModule } from '@nestjs/testing';
-import { RouteController } from './route.controller';
+import { RoutesController } from './routes.controller';
 
-describe('RouteController', () => {
-  let controller: RouteController;
+describe('RoutesController', () => {
+  let controller: RoutesController;
 
   beforeEach(async () => {
     const module: TestingModule = await Test.createTestingModule({
-      controllers: [RouteController],
+      controllers: [RoutesController],
     }).compile();
 
-    controller = module.get<RouteController>(RouteController);
+    controller = module.get<RoutesController>(RoutesController);
   });
 
   it('should be defined', () => {

src/routes/routes.controller.ts

@@ -0,0 +1,14 @@
+import { Controller, Get, Param } from '@nestjs/common';
+import { RoutesService } from './routes.service';
+import { ApiTags } from '@nestjs/swagger';
+
+@Controller('routes')
+@ApiTags('routes')
+export class RoutesController {
+  constructor(private readonly routesService: RoutesService) {}
+
+  @Get()
+  getAllRoutes(): object {
+    return this.routesService.getRoutes();
+  }
+}

src/routes/routes.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { RoutesService } from './routes.service';
+import { RoutesController } from './routes.controller';
+import { HttpModule } from '@nestjs/axios';
+
+@Module({
+  imports: [HttpModule],
+  controllers: [RoutesController],
+  providers: [RoutesService]
+})
+export class RoutesModule {}

src/route/route.service.spec.ts → src/routes/routes.service.spec.ts

@@ -1,15 +1,15 @@
 import { Test, TestingModule } from '@nestjs/testing';
-import { RouteService } from './route.service';
+import { RoutesService } from './routes.service';
 
-describe('RouteService', () => {
-  let service: RouteService;
+describe('RoutesService', () => {
+  let service: RoutesService;
 
   beforeEach(async () => {
     const module: TestingModule = await Test.createTestingModule({
-      providers: [RouteService],
+      providers: [RoutesService],
     }).compile();
 
-    service = module.get<RouteService>(RouteService);
+    service = module.get<RoutesService>(RoutesService);
   });
 
   it('should be defined', () => {