[김하린] 휴대폰 인증 API

nest-cli.json

@@ -3,6 +3,13 @@
   "collection": "@nestjs/schematics",
   "sourceRoot": "src",
   "compilerOptions": {
+    "plugins": [{
+      "name": "@nestjs/swagger",
+      "options": {
+        "classValidatorShim": false,
+        "introspectComments": true
+      }
+    }],
     "deleteOutDir": true
   }
 }

src/app.module.ts

@@ -3,6 +3,11 @@ import { TypeOrmModule } from '@nestjs/typeorm';
 import { ConfigModule } from '@nestjs/config';
 import { addTransactionalDataSource } from 'typeorm-transactional';
 import { DataSource } from 'typeorm';
+import { PhoneVerifyModule } from './domain/phone-verify/phone-verify.module';
+import { PhoneVerifyController } from './apps/phone-verify/phone-verify.controller';
+import { PhoneVerify } from './domain/phone-verify/phone-verify.entity';
+import { APP_FILTER } from '@nestjs/core';
+import { HttpExceptionFilter } from './common/error/http-exception.filter';
 
 @Module({
   imports: [
@@ -17,19 +22,26 @@ import { DataSource } from 'typeorm';
           password: process.env.DB_PASSWORD,
           database: process.env.DB_DATABASE,
           synchronize: process.env.DB_SYNC === 'true',
+          entities: [PhoneVerify],
           timezone: 'Z',
         };
       },
       async dataSourceFactory(options) {
         if (!options) {
           throw new Error('Invalid options passed');
         }
-
         return addTransactionalDataSource(new DataSource(options));
       },
     }),
+    TypeOrmModule.forFeature([PhoneVerify]),
+    PhoneVerifyModule,
+  ],
+  controllers: [PhoneVerifyController],
+  providers: [
+    {
+      provide: APP_FILTER,
+      useClass: HttpExceptionFilter,
+    },
   ],
-  controllers: [],
-  providers: [],
 })
 export class AppModule {}

src/apps/phone-verify/phone-verify.controller.ts

@@ -0,0 +1,29 @@
+import { Body, Controller, Patch, Post } from '@nestjs/common';
+import { PhoneVerifyService } from '../../domain/phone-verify/phone-verify.service';
+import { PhoneVerifyCodeRequestDto } from '../../domain/phone-verify/dto/request/phone-verify-code-request.dto';
+import { PhoneVerifyCodeResponseDto } from '../../domain/phone-verify/dto/response/phone-verify-code-response.dto';
+import { PhoneVerifyRequestDto } from '../../domain/phone-verify/dto/request/phone-verify-request.dto';
+import { ApiOperation, ApiTags } from '@nestjs/swagger';
+@Controller('phone-verifications')
+@ApiTags('phone-verifications')
+export class PhoneVerifyController {
+  constructor(private readonly phoneVerifyService: PhoneVerifyService) {}
+
+  @ApiOperation({
+    summary: '휴대폰 인증번호 발송',
+  })
+  @Post('/phone-verifications')
+  async sendVerifyCode(
+    @Body() dto: PhoneVerifyCodeRequestDto,
+  ): Promise<PhoneVerifyCodeResponseDto> {
+    return this.phoneVerifyService.sendVerifyCode(dto);
+  }
+
+  @ApiOperation({
+    summary: '휴대폰 인증',
+  })
+  @Patch('/phone-verifications')
+  verify(@Body() dto: PhoneVerifyRequestDto) {
+    return this.phoneVerifyService.verify(dto);
+  }
+}

src/common/constant.ts

@@ -0,0 +1,4 @@
+export const Messages = {
+  // auth
+  ERROR_AUTH_FAIL: '인증에 실패했습니다.',
+};

src/common/error/error-response.ts

@@ -0,0 +1,21 @@
+import { HttpException } from '@nestjs/common';
+
+export class ErrorResponse {
+  public status: number;
+  public code: string;
+  public message: string;
+
+  constructor(exception: HttpException) {
+    this.status = exception.getStatus();
+    this.code = exception.getResponse()['error'];
+    this.message = exception.getResponse()['message'];
+  }
+
+  toJson() {
+    return {
+      status: this.status,
+      code: this.code,
+      message: this.message,
+    };
+  }
+}

src/common/error/http-exception.filter.ts

@@ -0,0 +1,18 @@
+import {
+  ArgumentsHost,
+  Catch,
+  ExceptionFilter,
+  HttpException,
+} from '@nestjs/common';
+import { ErrorResponse } from './error-response';
+
+@Catch(HttpException)
+export class HttpExceptionFilter implements ExceptionFilter {
+  catch(exception: HttpException, host: ArgumentsHost) {
+    const ctx = host.switchToHttp();
+    const response = ctx.getResponse();
+    const errorResponse = new ErrorResponse(exception);
+
+    response.status(errorResponse.status).json(errorResponse.toJson());
+  }
+}

src/common/error/index.ts

@@ -0,0 +1,8 @@
+import { UnauthorizedException } from '@nestjs/common';
+
+/* 401 Unauthorized */
+export class AuthFailedException extends UnauthorizedException {
+  constructor(message?: string, code?: string) {
+    super(message ?? '인증에 실패하였습니다.', code ?? 'AUTH_FAILED');
+  }
+}

src/common/util.ts

@@ -0,0 +1,11 @@
+export function generateNumericToken(
+  length: number = 6,
+  alphabet: string = '1234567890',
+): string {
+  let id = '';
+  let i = length;
+  while (i--) {
+    id += alphabet[(Math.random() * alphabet.length) | 0];
+  }
+  return id;
+}

src/common/validator/index.ts

@@ -0,0 +1,4 @@
+export const validator = {
+  PHONE_NUMBER_REGEX: '^[0-9]{11}$',
+  VERIFY_CODE_REGEX: '^[0-9]{6}$',
+};

src/domain/phone-verify/dto/request/phone-verify-code-request.dto.ts

@@ -0,0 +1,8 @@
+import { IsString, Matches } from 'class-validator';
+import { validator } from '../../../../common/validator';
+
+export class PhoneVerifyCodeRequestDto {
+  @IsString()
+  @Matches(validator.PHONE_NUMBER_REGEX)
+  phoneNumber: string;
+}

src/domain/phone-verify/dto/request/phone-verify-request.dto.ts

@@ -0,0 +1,12 @@
+import { IsString, Matches } from 'class-validator';
+import { validator } from '../../../../common/validator';
+
+export class PhoneVerifyRequestDto {
+  @IsString()
+  @Matches(validator.PHONE_NUMBER_REGEX)
+  phoneNumber: string;
+
+  @IsString()
+  @Matches(validator.VERIFY_CODE_REGEX)
+  verifyCode: string;
+}

src/domain/phone-verify/dto/response/phone-verify-code-response.dto.ts

@@ -0,0 +1,3 @@
+export class PhoneVerifyCodeResponseDto {
+  code: string;
+}

src/domain/phone-verify/dto/response/phone-verify-response.dto.ts

@@ -0,0 +1,3 @@
+export class PhoneVerifyResponseDto {
+  result: boolean;
+}

src/domain/phone-verify/phone-verify.entity.ts

@@ -0,0 +1,31 @@
+import {
+  Column,
+  CreateDateColumn,
+  Entity,
+  PrimaryGeneratedColumn,
+  UpdateDateColumn,
+} from 'typeorm';
+
+@Entity()
+export class PhoneVerify {
+  @PrimaryGeneratedColumn()
+  id: number;
+
+  @CreateDateColumn()
+  createdAt: Date;
+
+  @UpdateDateColumn()
+  updatedAt: Date;
+
+  @Column()
+  phoneNumber: string;
+
+  @Column()
+  verifyCode: string;
+
+  @Column({ default: false })
+  isVerified: boolean;
+
+  @Column()
+  expiredAt: Date;
+}

src/domain/phone-verify/phone-verify.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { PhoneVerifyService } from './phone-verify.service';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { PhoneVerify } from './phone-verify.entity';
+
+@Module({
+  imports: [TypeOrmModule.forFeature([PhoneVerify])],
+  providers: [PhoneVerifyService],
+  exports: [PhoneVerifyService],
+})
+export class PhoneVerifyModule {}

src/domain/phone-verify/phone-verify.service.ts

@@ -0,0 +1,62 @@
+import { Injectable } from '@nestjs/common';
+import { InjectRepository } from '@nestjs/typeorm';
+import { PhoneVerify } from './phone-verify.entity';
+import { Repository } from 'typeorm';
+import { PhoneVerifyCodeRequestDto } from './dto/request/phone-verify-code-request.dto';
+import { PhoneVerifyCodeResponseDto } from './dto/response/phone-verify-code-response.dto';
+import { generateNumericToken } from '../../common/util';
+import { PhoneVerifyRequestDto } from './dto/request/phone-verify-request.dto';
+import { PhoneVerifyResponseDto } from './dto/response/phone-verify-response.dto';
+
+const VERIFY_CODE_VALID_TIME = 5;
+
+@Injectable()
+export class PhoneVerifyService {
+  constructor(
+    @InjectRepository(PhoneVerify)
+    private readonly phoneVerifyRepository: Repository<PhoneVerify>,
+  ) {}
+
+  async sendVerifyCode(
+    dto: PhoneVerifyCodeRequestDto,
+  ): Promise<PhoneVerifyCodeResponseDto> {
+    const verifyCode = generateNumericToken();
+
+    const expiredDate = new Date();
+    expiredDate.setMinutes(expiredDate.getMinutes() + VERIFY_CODE_VALID_TIME);
+
+    const phoneVerify = new PhoneVerify();
+    phoneVerify.verifyCode = verifyCode;
+    phoneVerify.phoneNumber = dto.phoneNumber;
+    phoneVerify.expiredAt = expiredDate;
+
+    await this.phoneVerifyRepository.save(phoneVerify);
+
+    const response = new PhoneVerifyCodeResponseDto();
+    response.code = verifyCode;
+
+    return response;
+  }
+
+  async verify(dto: PhoneVerifyRequestDto) {
+    const phoneVerification = await this.phoneVerifyRepository
+      .createQueryBuilder('pv')
+      .where('pv.phoneNumber = :phoneNumber', { phoneNumber: dto.phoneNumber })
+      .andWhere('pv.verifyCode = :verifyCode', { verifyCode: dto.verifyCode })
+      .andWhere('pv.isVerified = false')
+      .andWhere('pv.expiredAt > NOW()')
+      .orderBy({ createdAt: 'DESC' })
+      .getOne();
+
+    const response = new PhoneVerifyResponseDto();
+    if (!phoneVerification) {
+      response.result = false;
+      return response;
+    }
+
+    phoneVerification.isVerified = true;
+    await this.phoneVerifyRepository.save(phoneVerification);
+    response.result = true;
+    return response;
+  }
+}

src/main.ts

@@ -1,12 +1,34 @@
 import { NestFactory } from '@nestjs/core';
 import { AppModule } from './app.module';
 import { initializeTransactionalContext } from 'typeorm-transactional';
+import { ValidationPipe } from '@nestjs/common';
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
+import { HttpExceptionFilter } from './common/error/http-exception.filter';
 
 async function bootstrap() {
   initializeTransactionalContext();
 
   const app = await NestFactory.create(AppModule);
-  // TODO: 프로그램 구현
+
+  // ---------------------------- Swagger 설정 ----------------------------
+  const config = new DocumentBuilder()
+    .setTitle('NestJS API')
+    .setDescription('어쩌다 Nest 과제 API')
+    .setVersion('1.0')
+    .build();
+  const swaggerOptions = {
+    operationIdFactory: (controllerKey: string, methodKey: string) => methodKey,
+  };
+
+  const document = SwaggerModule.createDocument(app, config, swaggerOptions);
+  SwaggerModule.setup('api', app, document);
+
+  // ---------------------------- Global Pipe 설정 ----------------------------
+  app.useGlobalPipes(new ValidationPipe({ transform: true }));
+
+  // ---------------------------- Global Filter 설정 ----------------------------
+  app.useGlobalFilters(new HttpExceptionFilter());
+
   await app.listen(process.env.PORT || 8000);
 
   console.log(`Application is running on: ${await app.getUrl()}`);