diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..8af972c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,3 @@ +/gradlew text eol=lf +*.bat text eol=crlf +*.jar binary diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..fdf5ae8 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,36 @@ +name: Deploy to EC2 + +on: + push: + branches: + - main + +jobs: # 잡 (Jobs) : 워크플로우에서 실행되는 작업 단위 + build-and-deploy: # 잡 이름 + runs-on: ubuntu-latest + + steps: + # 1. GitHub 레포지토리 체크아웃 + - name: Checkout Repository + uses: actions/checkout@v3 + + # 2. Docker 이미지 빌드 & 푸시 + - name: Build and Push Docker Image to Docker Hub + run: | + docker build -t ${{ secrets.DOCKER_HUB_USERNAME }}/ktb-be-assignment --platform linux/amd64 . + docker push ${{ secrets.DOCKER_HUB_USERNAME }}/ktb-be-assignment + + # 3. EC2 접속 & 어플리케이션 실행 + - name: Deploy to EC2 + uses: appleboy/ssh-action@master + with: + host: ${{ secrets.EC2_HOST }} + username: ${{ secrets.EC2_USERNAME }} + port: 22 + key: ${{ secrets.EC2_SSH_KEY }} + script: | + docker pull ${{ secrets.DOCKER_HUB_USERNAME }}/ktb-be-assignment + cd ~/app + echo "${{ secrets.APPLICATION_CONFIG }}" > ./config/application-secret.yml + docker-compose down + docker-compose up -d \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..37e5848 --- /dev/null +++ b/.gitignore @@ -0,0 +1,43 @@ +HELP.md +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ + +### application.yml ### +application-*.yml + +### shell script +*.sh diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..9bcf05d --- /dev/null +++ b/Dockerfile @@ -0,0 +1,18 @@ +FROM gradle:8.7.0-jdk17 as builder +WORKDIR /app + +COPY build.gradle settings.gradle gradlew /app/ +COPY gradle /app/gradle +COPY src /app/src + +RUN ./gradlew build + +# 배포 +FROM eclipse-temurin:17-jre-jammy as app +WORKDIR /app + +COPY --from=builder /app/build/libs/*.jar app.jar + +# 애플리케이션 실행 +EXPOSE 8080 +ENTRYPOINT ["java", "-jar", "/app/app.jar"] \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..60e17c4 --- /dev/null +++ b/build.gradle @@ -0,0 +1,52 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '3.4.2' + id 'io.spring.dependency-management' version '1.1.7' +} + +group = 'ktb.mason' +version = '0.0.1-SNAPSHOT' + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(17) + } +} + +configurations { + compileOnly { + extendsFrom annotationProcessor + } +} + +repositories { + mavenCentral() +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter-data-jpa' + implementation 'org.springframework.boot:spring-boot-starter-web' + implementation 'org.springframework.boot:spring-boot-starter-validation:3.4.2' + + // MySQL + runtimeOnly 'com.mysql:mysql-connector-j' + + // Query DSL + implementation 'com.querydsl:querydsl-jpa:5.0.0:jakarta' + annotationProcessor "com.querydsl:querydsl-apt:5.0.0:jakarta" + annotationProcessor "jakarta.annotation:jakarta.annotation-api" + annotationProcessor "jakarta.persistence:jakarta.persistence-api" + + // Lombok + compileOnly 'org.projectlombok:lombok' + annotationProcessor 'org.projectlombok:lombok' + testAnnotationProcessor 'org.projectlombok:lombok' + testCompileOnly 'org.projectlombok:lombok' + + testImplementation 'org.springframework.boot:spring-boot-starter-test' + testRuntimeOnly 'org.junit.platform:junit-platform-launcher' +} + +tasks.named('test') { + useJUnitPlatform() +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..a4b76b9 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..e18bc25 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.12.1-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..f5feea6 --- /dev/null +++ b/gradlew @@ -0,0 +1,252 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s +' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..9d21a21 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,94 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..abd6e44 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'be-assignment' diff --git a/src/main/java/ktb/mason/be_assignment/BeAssignmentApplication.java b/src/main/java/ktb/mason/be_assignment/BeAssignmentApplication.java new file mode 100644 index 0000000..81d3947 --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/BeAssignmentApplication.java @@ -0,0 +1,15 @@ +package ktb.mason.be_assignment; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.boot.context.properties.EnableConfigurationProperties; + +@SpringBootApplication +@EnableConfigurationProperties +public class BeAssignmentApplication { + + public static void main(String[] args) { + SpringApplication.run(BeAssignmentApplication.class, args); + } + +} diff --git a/src/main/java/ktb/mason/be_assignment/domain/stock/controller/StockController.java b/src/main/java/ktb/mason/be_assignment/domain/stock/controller/StockController.java new file mode 100644 index 0000000..49d64ec --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/domain/stock/controller/StockController.java @@ -0,0 +1,36 @@ +package ktb.mason.be_assignment.domain.stock.controller; + +import ktb.mason.be_assignment.domain.stock.controller.port.StockService; +import ktb.mason.be_assignment.domain.stock.controller.response.StockInfoResponse; +import ktb.mason.be_assignment.global.api.BaseResponse; +import ktb.mason.be_assignment.global.validate.ApiKey; +import ktb.mason.be_assignment.global.validate.Code; +import ktb.mason.be_assignment.global.validate.Date; +import lombok.AccessLevel; +import lombok.RequiredArgsConstructor; +import lombok.experimental.FieldDefaults; +import org.springframework.validation.annotation.Validated; +import org.springframework.web.bind.annotation.*; + +@Validated +@RestController +@RequiredArgsConstructor +@RequestMapping("/api/v1/stocks") +@FieldDefaults(level = AccessLevel.PRIVATE) +public class StockController { + + final StockService stockService; + + @ApiKey + @GetMapping("") + public BaseResponse getStockInfoByCompanyCode( + @Code @RequestParam(value = "company_code") String companyCode, + @Date @RequestParam(value = "start_date") String startDate, + @Date @RequestParam(value = "end_date") String endDate + ) { + + return BaseResponse.success( + stockService.getStockInfoByCompanyCode(companyCode, startDate, endDate) + ); + } +} diff --git a/src/main/java/ktb/mason/be_assignment/domain/stock/controller/port/StockService.java b/src/main/java/ktb/mason/be_assignment/domain/stock/controller/port/StockService.java new file mode 100644 index 0000000..6854443 --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/domain/stock/controller/port/StockService.java @@ -0,0 +1,7 @@ +package ktb.mason.be_assignment.domain.stock.controller.port; + +import ktb.mason.be_assignment.domain.stock.controller.response.StockInfoResponse; + +public interface StockService { + StockInfoResponse getStockInfoByCompanyCode(String companyCode, String startDate, String endDate); +} diff --git a/src/main/java/ktb/mason/be_assignment/domain/stock/controller/response/CompanyResponse.java b/src/main/java/ktb/mason/be_assignment/domain/stock/controller/response/CompanyResponse.java new file mode 100644 index 0000000..d6cdd55 --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/domain/stock/controller/response/CompanyResponse.java @@ -0,0 +1,24 @@ +package ktb.mason.be_assignment.domain.stock.controller.response; + +import ktb.mason.be_assignment.domain.stock.domain.Company; +import lombok.AccessLevel; +import lombok.Builder; +import lombok.Getter; +import lombok.ToString; +import lombok.experimental.FieldDefaults; + +@Getter +@Builder +@ToString +@FieldDefaults(level = AccessLevel.PRIVATE) +public class CompanyResponse { + final String code; + final String name; + + public static CompanyResponse from(Company company) { + return CompanyResponse.builder() + .code(company.getCompanyCode()) + .name(company.getCompanyName()) + .build(); + } +} diff --git a/src/main/java/ktb/mason/be_assignment/domain/stock/controller/response/StockHistoryResponse.java b/src/main/java/ktb/mason/be_assignment/domain/stock/controller/response/StockHistoryResponse.java new file mode 100644 index 0000000..1c8320a --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/domain/stock/controller/response/StockHistoryResponse.java @@ -0,0 +1,28 @@ +package ktb.mason.be_assignment.domain.stock.controller.response; + +import com.fasterxml.jackson.annotation.JsonFormat; +import ktb.mason.be_assignment.domain.stock.domain.StockHistory; +import lombok.AccessLevel; +import lombok.Builder; +import lombok.Getter; +import lombok.ToString; +import lombok.experimental.FieldDefaults; + +import java.time.LocalDate; + +@Getter +@Builder +@ToString +@FieldDefaults(level = AccessLevel.PRIVATE) +public class StockHistoryResponse { + @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd", timezone = "Asia/Seoul") + final LocalDate tradeDate; + final Double closePrice; + + public static StockHistoryResponse from (StockHistory stockHistory) { + return StockHistoryResponse.builder() + .tradeDate(stockHistory.getTradeDate()) + .closePrice(stockHistory.getClosePrice()) + .build(); + } +} diff --git a/src/main/java/ktb/mason/be_assignment/domain/stock/controller/response/StockInfoResponse.java b/src/main/java/ktb/mason/be_assignment/domain/stock/controller/response/StockInfoResponse.java new file mode 100644 index 0000000..9b9fefa --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/domain/stock/controller/response/StockInfoResponse.java @@ -0,0 +1,28 @@ +package ktb.mason.be_assignment.domain.stock.controller.response; + +import ktb.mason.be_assignment.domain.stock.domain.StockInfo; +import lombok.AccessLevel; +import lombok.Builder; +import lombok.Getter; +import lombok.ToString; +import lombok.experimental.FieldDefaults; + +import java.util.List; + +@Getter +@Builder +@ToString +@FieldDefaults(level = AccessLevel.PRIVATE) +public class StockInfoResponse { + final CompanyResponse company; + final List stockHistories; + + public static StockInfoResponse from (StockInfo stockInfo) { + return StockInfoResponse.builder() + .company(CompanyResponse.from(stockInfo.getCompany())) + .stockHistories(stockInfo.getStockHistories().stream() + .map(StockHistoryResponse::from) + .toList()) + .build(); + } +} diff --git a/src/main/java/ktb/mason/be_assignment/domain/stock/domain/Company.java b/src/main/java/ktb/mason/be_assignment/domain/stock/domain/Company.java new file mode 100644 index 0000000..21b7bb6 --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/domain/stock/domain/Company.java @@ -0,0 +1,19 @@ +package ktb.mason.be_assignment.domain.stock.domain; + +import lombok.AccessLevel; +import lombok.Builder; +import lombok.Getter; +import lombok.experimental.FieldDefaults; + +@Getter +@FieldDefaults(level = AccessLevel.PRIVATE) +public class Company { + final String companyCode; + final String companyName; + + @Builder + public Company(String companyCode, String companyName) { + this.companyCode = companyCode; + this.companyName = companyName; + } +} diff --git a/src/main/java/ktb/mason/be_assignment/domain/stock/domain/StockHistory.java b/src/main/java/ktb/mason/be_assignment/domain/stock/domain/StockHistory.java new file mode 100644 index 0000000..9896b56 --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/domain/stock/domain/StockHistory.java @@ -0,0 +1,31 @@ +package ktb.mason.be_assignment.domain.stock.domain; + +import lombok.AccessLevel; +import lombok.Builder; +import lombok.Getter; +import lombok.experimental.FieldDefaults; + +import java.time.LocalDate; + +@Getter +@FieldDefaults(level = AccessLevel.PRIVATE) +public class StockHistory { + final String companyCode; + final Double openPrice; + final Double highPrice; + final Double lowPrice; + final Double closePrice; + final Double volume; + final LocalDate tradeDate; + + @Builder + public StockHistory(String companyCode, Double openPrice, Double highPrice, Double lowPrice, Double closePrice, Double volume, LocalDate tradeDate) { + this.companyCode = companyCode; + this.openPrice = openPrice; + this.highPrice = highPrice; + this.lowPrice = lowPrice; + this.closePrice = closePrice; + this.volume = volume; + this.tradeDate = tradeDate; + } +} diff --git a/src/main/java/ktb/mason/be_assignment/domain/stock/domain/StockInfo.java b/src/main/java/ktb/mason/be_assignment/domain/stock/domain/StockInfo.java new file mode 100644 index 0000000..a4ec06a --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/domain/stock/domain/StockInfo.java @@ -0,0 +1,20 @@ +package ktb.mason.be_assignment.domain.stock.domain; + +import lombok.AccessLevel; +import lombok.Builder; +import lombok.Getter; +import lombok.experimental.FieldDefaults; + +import java.util.List; + +@Getter +@FieldDefaults(level = AccessLevel.PRIVATE) +public class StockInfo { + final Company company; + final List stockHistories; + @Builder + public StockInfo(Company company, List stockHistories) { + this.company = company; + this.stockHistories = stockHistories; + } +} diff --git a/src/main/java/ktb/mason/be_assignment/domain/stock/infrastructure/entity/CompanyEntity.java b/src/main/java/ktb/mason/be_assignment/domain/stock/infrastructure/entity/CompanyEntity.java new file mode 100644 index 0000000..2df9559 --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/domain/stock/infrastructure/entity/CompanyEntity.java @@ -0,0 +1,44 @@ +package ktb.mason.be_assignment.domain.stock.infrastructure.entity; + +import jakarta.persistence.*; +import ktb.mason.be_assignment.domain.stock.domain.Company; +import lombok.AccessLevel; +import lombok.Builder; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.experimental.FieldDefaults; + +@Entity +@Table(name = "company") +@Getter +@NoArgsConstructor +@FieldDefaults(level = AccessLevel.PRIVATE) +public class CompanyEntity { + + @Id + @Column(name = "company_code") + String companyCode; + + @Column(name = "company_name") + String companyName; + + @Builder + public CompanyEntity(String companyCode, String companyName) { + this.companyCode = companyCode; + this.companyName = companyName; + } + + public static CompanyEntity from(Company company) { + return CompanyEntity.builder() + .companyCode(company.getCompanyCode()) + .companyName(company.getCompanyName()) + .build(); + } + + public Company toModel() { + return Company.builder() + .companyCode(this.companyCode) + .companyName(this.companyName) + .build(); + } +} diff --git a/src/main/java/ktb/mason/be_assignment/domain/stock/infrastructure/entity/StockHistoryEntity.java b/src/main/java/ktb/mason/be_assignment/domain/stock/infrastructure/entity/StockHistoryEntity.java new file mode 100644 index 0000000..9f5e650 --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/domain/stock/infrastructure/entity/StockHistoryEntity.java @@ -0,0 +1,74 @@ +package ktb.mason.be_assignment.domain.stock.infrastructure.entity; + +import jakarta.persistence.*; +import ktb.mason.be_assignment.domain.stock.domain.StockHistory; +import lombok.AccessLevel; +import lombok.Builder; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.experimental.FieldDefaults; + +import java.time.LocalDate; + +@Entity +@Table(name = "stocks_history") +@Getter +@NoArgsConstructor +@FieldDefaults(level = AccessLevel.PRIVATE) +public class StockHistoryEntity { + + @EmbeddedId + StockHistoryPK pk; + + @Column(name = "open_price") + Double openPrice; + + @Column(name = "high_price") + Double highPrice; + + @Column(name = "low_price") + Double lowPrice; + + @Column(name = "close_price") + Double closePrice; + + @Column(name = "volume") + Double volume; + + @Builder + public StockHistoryEntity(String companyCode, Double openPrice, Double highPrice, Double lowPrice, Double closePrice, Double volume, LocalDate tradeDate) { + this.pk = StockHistoryPK.builder() + .companyCode(companyCode) + .tradeDate(tradeDate) + .build(); + this.openPrice = openPrice; + this.highPrice = highPrice; + this.lowPrice = lowPrice; + this.closePrice = closePrice; + this.volume = volume; + } + + public static StockHistoryEntity from(StockHistory stockHistory) { + return StockHistoryEntity.builder() + .companyCode(stockHistory.getCompanyCode()) + .openPrice(stockHistory.getOpenPrice()) + .highPrice(stockHistory.getHighPrice()) + .lowPrice(stockHistory.getLowPrice()) + .closePrice(stockHistory.getClosePrice()) + .volume(stockHistory.getVolume()) + .tradeDate(stockHistory.getTradeDate()) + .build(); + } + + public StockHistory toModel() { + return StockHistory.builder() + .companyCode(this.pk.getCompanyCode()) + .openPrice(this.openPrice) + .highPrice(this.highPrice) + .lowPrice(this.lowPrice) + .closePrice(this.closePrice) + .volume(this.volume) + .tradeDate(this.pk.getTradeDate()) + .build(); + } +} diff --git a/src/main/java/ktb/mason/be_assignment/domain/stock/infrastructure/entity/StockHistoryPK.java b/src/main/java/ktb/mason/be_assignment/domain/stock/infrastructure/entity/StockHistoryPK.java new file mode 100644 index 0000000..e3875cc --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/domain/stock/infrastructure/entity/StockHistoryPK.java @@ -0,0 +1,27 @@ +package ktb.mason.be_assignment.domain.stock.infrastructure.entity; + +import jakarta.persistence.Column; +import jakarta.persistence.Embeddable; +import lombok.Builder; +import lombok.Getter; +import lombok.NoArgsConstructor; + +import java.io.Serializable; +import java.time.LocalDate; + +@Embeddable +@NoArgsConstructor +@Getter +public class StockHistoryPK implements Serializable { + @Column(name = "company_code") + String companyCode; + + @Column(name = "trade_date") + LocalDate tradeDate; + + @Builder + public StockHistoryPK(String companyCode, LocalDate tradeDate) { + this.companyCode = companyCode; + this.tradeDate = tradeDate; + } +} diff --git a/src/main/java/ktb/mason/be_assignment/domain/stock/infrastructure/repository/CompanyRepositoryImpl.java b/src/main/java/ktb/mason/be_assignment/domain/stock/infrastructure/repository/CompanyRepositoryImpl.java new file mode 100644 index 0000000..b8a6a5b --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/domain/stock/infrastructure/repository/CompanyRepositoryImpl.java @@ -0,0 +1,32 @@ +package ktb.mason.be_assignment.domain.stock.infrastructure.repository; + +import com.querydsl.jpa.impl.JPAQueryFactory; +import ktb.mason.be_assignment.domain.stock.domain.Company; +import ktb.mason.be_assignment.domain.stock.infrastructure.entity.CompanyEntity; +import ktb.mason.be_assignment.domain.stock.service.port.CompanyRepository; +import lombok.AccessLevel; +import lombok.RequiredArgsConstructor; +import lombok.experimental.FieldDefaults; +import org.springframework.stereotype.Repository; + +import java.util.Optional; + +import static ktb.mason.be_assignment.domain.stock.infrastructure.entity.QCompanyEntity.companyEntity; + +@Repository +@RequiredArgsConstructor +@FieldDefaults(level = AccessLevel.PRIVATE) +public class CompanyRepositoryImpl implements CompanyRepository { + + final JPAQueryFactory query; + + @Override + public Optional findByCompanyCode(String companyCode) { + + return Optional.ofNullable(query.select(companyEntity) + .from(companyEntity) + .where(companyEntity.companyCode.eq(companyCode)) + .fetchOne()) + .map(CompanyEntity::toModel); + } +} diff --git a/src/main/java/ktb/mason/be_assignment/domain/stock/infrastructure/repository/StockHistoryRepositoryImpl.java b/src/main/java/ktb/mason/be_assignment/domain/stock/infrastructure/repository/StockHistoryRepositoryImpl.java new file mode 100644 index 0000000..c9cb0c8 --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/domain/stock/infrastructure/repository/StockHistoryRepositoryImpl.java @@ -0,0 +1,52 @@ +package ktb.mason.be_assignment.domain.stock.infrastructure.repository; + +import com.querydsl.core.Tuple; +import com.querydsl.core.types.dsl.BooleanExpression; +import com.querydsl.jpa.impl.JPAQueryFactory; +import ktb.mason.be_assignment.domain.stock.domain.StockHistory; +import ktb.mason.be_assignment.domain.stock.infrastructure.entity.StockHistoryEntity; +import ktb.mason.be_assignment.domain.stock.service.port.StockHistoryRepository; +import lombok.AccessLevel; +import lombok.RequiredArgsConstructor; +import lombok.experimental.FieldDefaults; +import org.springframework.stereotype.Repository; + +import java.time.LocalDate; +import java.util.List; + +import static ktb.mason.be_assignment.domain.stock.infrastructure.entity.QCompanyEntity.companyEntity; +import static ktb.mason.be_assignment.domain.stock.infrastructure.entity.QStockHistoryEntity.stockHistoryEntity; + +@Repository +@RequiredArgsConstructor +@FieldDefaults(level = AccessLevel.PRIVATE) +public class StockHistoryRepositoryImpl implements StockHistoryRepository { + + final JPAQueryFactory query; + + @Override + public List findAllByCompanyAndDateRange(String companyCode, String startDate, String endDate) { + + return query + .select(stockHistoryEntity) + .from(stockHistoryEntity) + .join(companyEntity) + .on(stockHistoryEntity.pk.companyCode.eq(companyEntity.companyCode)) + .where(byCompanyCodeAndDate(companyCode, startDate, endDate)) + .fetch() + .stream() + .map(StockHistoryEntity::toModel) + .toList(); + } + + BooleanExpression byCompanyCodeAndDate(String companyCode, String startDate, String endDate) { + if(companyCode == null || startDate == null || endDate == null) return null; + + LocalDate s = LocalDate.parse(startDate); + LocalDate e = LocalDate.parse(endDate); + + return stockHistoryEntity.pk.companyCode.eq(companyCode) + .and(stockHistoryEntity.pk.tradeDate.goe(s)) + .and(stockHistoryEntity.pk.tradeDate.loe(e)); + } +} diff --git a/src/main/java/ktb/mason/be_assignment/domain/stock/service/StockServiceImpl.java b/src/main/java/ktb/mason/be_assignment/domain/stock/service/StockServiceImpl.java new file mode 100644 index 0000000..1061737 --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/domain/stock/service/StockServiceImpl.java @@ -0,0 +1,44 @@ +package ktb.mason.be_assignment.domain.stock.service; + +import ktb.mason.be_assignment.domain.stock.controller.port.StockService; +import ktb.mason.be_assignment.domain.stock.controller.response.StockInfoResponse; +import ktb.mason.be_assignment.domain.stock.domain.Company; +import ktb.mason.be_assignment.domain.stock.domain.StockHistory; +import ktb.mason.be_assignment.domain.stock.domain.StockInfo; +import ktb.mason.be_assignment.domain.stock.service.port.CompanyRepository; +import ktb.mason.be_assignment.domain.stock.service.port.StockHistoryRepository; +import ktb.mason.be_assignment.global.api.ApiException; +import ktb.mason.be_assignment.global.api.AppHttpStatus; +import lombok.AccessLevel; +import lombok.Builder; +import lombok.RequiredArgsConstructor; +import lombok.experimental.FieldDefaults; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +import java.util.List; + +@Service +@Builder +@RequiredArgsConstructor +@Transactional +@FieldDefaults(level = AccessLevel.PRIVATE) +public class StockServiceImpl implements StockService { + + final StockHistoryRepository stockHistoryRepository; + final CompanyRepository companyRepository; + @Override + @Transactional(readOnly = true) + public StockInfoResponse getStockInfoByCompanyCode(String companyCode, String startDate, String endDate) { + + Company company = companyRepository.findByCompanyCode(companyCode) + .orElseThrow(() -> new ApiException(AppHttpStatus.NOT_FOUND_COMPANY)); + + List stockHistories = stockHistoryRepository.findAllByCompanyAndDateRange(companyCode, startDate, endDate); + + return StockInfoResponse.from(StockInfo.builder() + .company(company) + .stockHistories(stockHistories) + .build()); + } +} diff --git a/src/main/java/ktb/mason/be_assignment/domain/stock/service/port/CompanyRepository.java b/src/main/java/ktb/mason/be_assignment/domain/stock/service/port/CompanyRepository.java new file mode 100644 index 0000000..f72c579 --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/domain/stock/service/port/CompanyRepository.java @@ -0,0 +1,9 @@ +package ktb.mason.be_assignment.domain.stock.service.port; + +import ktb.mason.be_assignment.domain.stock.domain.Company; + +import java.util.Optional; + +public interface CompanyRepository { + Optional findByCompanyCode(String companyCode); +} diff --git a/src/main/java/ktb/mason/be_assignment/domain/stock/service/port/StockHistoryRepository.java b/src/main/java/ktb/mason/be_assignment/domain/stock/service/port/StockHistoryRepository.java new file mode 100644 index 0000000..41c6212 --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/domain/stock/service/port/StockHistoryRepository.java @@ -0,0 +1,9 @@ +package ktb.mason.be_assignment.domain.stock.service.port; + +import ktb.mason.be_assignment.domain.stock.domain.StockHistory; + +import java.util.List; + +public interface StockHistoryRepository { + List findAllByCompanyAndDateRange(String companyCode, String startDate, String endDate); +} diff --git a/src/main/java/ktb/mason/be_assignment/global/api/ApiException.java b/src/main/java/ktb/mason/be_assignment/global/api/ApiException.java new file mode 100644 index 0000000..bc80fae --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/global/api/ApiException.java @@ -0,0 +1,10 @@ +package ktb.mason.be_assignment.global.api; + +import lombok.Getter; +import lombok.RequiredArgsConstructor; + +@Getter +@RequiredArgsConstructor +public class ApiException extends RuntimeException { + private final AppHttpStatus status; +} diff --git a/src/main/java/ktb/mason/be_assignment/global/api/AppHttpStatus.java b/src/main/java/ktb/mason/be_assignment/global/api/AppHttpStatus.java new file mode 100644 index 0000000..9ef7ac4 --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/global/api/AppHttpStatus.java @@ -0,0 +1,49 @@ +package ktb.mason.be_assignment.global.api; + +import lombok.AllArgsConstructor; +import lombok.Getter; +import org.springframework.http.HttpStatus; + +@Getter +@AllArgsConstructor +public enum AppHttpStatus { + /** + * 20X : 성공 + */ + OK(200, HttpStatus.OK, "요청이 정상적으로 수행되었습니다."), + CREATED(201, HttpStatus.CREATED, "리소스를 생성하였습니다."), + + /** + * 400 : 잘못된 문법으로 인해 요청을 이해할 수 없음 + */ + BAD_REQUEST(400, HttpStatus.BAD_REQUEST, "잘못된 요청입니다."), + FAILED_VALIDATION(400, HttpStatus.BAD_REQUEST, "유효성 검사에 실패하였습니다."), + BLANK_NOT_ALLOWED(400, HttpStatus.BAD_REQUEST, "공백은 입력할 수 없습니다."), + INVALID_DATE_FORMAT(400, HttpStatus.BAD_REQUEST, "날짜 형식이 올바르지 않습니다. yyyy-MM-dd 형식이어야 합니다."), + + /** + * 401 : 인증된 사용자가 아님 + */ + UNAUTHORIZED(401, HttpStatus.UNAUTHORIZED, "인증되지 않은 사용자입니다."), + + /** + * 403 : 접근 권한이 없음 + */ + FORBIDDEN(403, HttpStatus.FORBIDDEN, "권한이 없습니다."), + + /** + * 404 : 응답할 리소스가 없음 + */ + NOT_FOUND(404, HttpStatus.NOT_FOUND, "존재하지 않는 리소스입니다."), + NOT_FOUND_ENDPOINT(404, HttpStatus.NOT_FOUND, "존재하지 않는 엔드포인트입니다."), + NOT_FOUND_COMPANY(404, HttpStatus.NOT_FOUND, "존재하지 않는 기업입니다."), + + /** + * 500 : 서버 내부에서 에러가 발생함 + */ + INTERNAL_SERVER_ERROR(500, HttpStatus.INTERNAL_SERVER_ERROR, "서버 내부에 에러가 발생했습니다."); + + private final int statusCode; + private final HttpStatus httpStatus; + private final String message; +} \ No newline at end of file diff --git a/src/main/java/ktb/mason/be_assignment/global/api/BaseResponse.java b/src/main/java/ktb/mason/be_assignment/global/api/BaseResponse.java new file mode 100644 index 0000000..b81f7c5 --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/global/api/BaseResponse.java @@ -0,0 +1,43 @@ +package ktb.mason.be_assignment.global.api; + +import com.fasterxml.jackson.annotation.JsonInclude; +import lombok.AccessLevel; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Getter; +import lombok.experimental.FieldDefaults; + +/** + * 응답 설계 이유 + * 1. 일관성 있는 응답 구조 + * 응답이 성공/실패 여부와 관계없이 동일한 구조를 유지할 수 있도록 하였습니다. + * 2. 클라이언트 고려 + * status에 따라서 응답을 쉽게 파싱할 수 있습니다. + */ + + +@Getter +@Builder +@AllArgsConstructor +@JsonInclude(JsonInclude.Include.NON_NULL) +@FieldDefaults(level = AccessLevel.PRIVATE) +public class BaseResponse { + + String status; + T data; + ErrorResponse error; + + public static BaseResponse success(T data) { + return BaseResponse.builder() + .status("success") + .data(data) + .build(); + } + + public static BaseResponse error(ErrorResponse e) { + return BaseResponse.builder() + .status("error") + .error(e) + .build(); + } +} diff --git a/src/main/java/ktb/mason/be_assignment/global/api/ErrorResponse.java b/src/main/java/ktb/mason/be_assignment/global/api/ErrorResponse.java new file mode 100644 index 0000000..6152bb4 --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/global/api/ErrorResponse.java @@ -0,0 +1,62 @@ +package ktb.mason.be_assignment.global.api; + +import com.fasterxml.jackson.annotation.JsonInclude; +import jakarta.validation.ConstraintViolation; +import jakarta.validation.ConstraintViolationException; +import lombok.AccessLevel; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Getter; +import lombok.experimental.FieldDefaults; +import org.springframework.web.servlet.resource.NoResourceFoundException; + +import java.util.HashMap; +import java.util.Map; +import java.util.Set; + +@Getter +@Builder +@AllArgsConstructor +@JsonInclude(JsonInclude.Include.NON_NULL) +@FieldDefaults(level = AccessLevel.PRIVATE) +public class ErrorResponse { + int code; + String message; + Map messages; + + public static ErrorResponse of(ApiException e) { + return ErrorResponse.builder() + .code(e.getStatus().getStatusCode()) + .message(e.getStatus().getMessage()) + .build(); + } + public static ErrorResponse of(RuntimeException e) { + return ErrorResponse.builder() + .code(500) + .message(e.getMessage()) + .build(); + } + public static ErrorResponse of(NoResourceFoundException e) { + String errorMessage = e.getResourcePath() + " : " + AppHttpStatus.NOT_FOUND_ENDPOINT.getMessage(); + return ErrorResponse.builder() + .code(404) + .message(errorMessage) + .build(); + } + + public static ErrorResponse of(ConstraintViolationException e) { + Set> violations = e.getConstraintViolations(); + + Map errors = new HashMap<>(); + for (ConstraintViolation v : violations) { + String field = v.getPropertyPath().toString().split("\\.")[1]; // e.g. method.field + String message = v.getMessageTemplate(); + errors.put(field, message); + } + + return ErrorResponse.builder() + .code(400) + .messages(errors) + .build(); + } +} diff --git a/src/main/java/ktb/mason/be_assignment/global/api/GlobalExceptionHandler.java b/src/main/java/ktb/mason/be_assignment/global/api/GlobalExceptionHandler.java new file mode 100644 index 0000000..549ca1c --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/global/api/GlobalExceptionHandler.java @@ -0,0 +1,48 @@ +package ktb.mason.be_assignment.global.api; + +import jakarta.validation.ConstraintViolationException; +import lombok.extern.slf4j.Slf4j; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.RestControllerAdvice; +import org.springframework.web.servlet.resource.NoResourceFoundException; + +@Slf4j +@RestControllerAdvice +public class GlobalExceptionHandler { + + @ExceptionHandler(RuntimeException.class) + public ResponseEntity> runtimeExceptionHandler(RuntimeException e) { + log.warn(500 + " " + e.getMessage()); + + return ResponseEntity + .status(500) + .body( BaseResponse.error(ErrorResponse.of(e))); + } + @ExceptionHandler(ApiException.class) + public ResponseEntity> apiExceptionHandler(ApiException e) { + log.warn(e.getStatus().getStatusCode() + " " + e.getStatus().getMessage()); + + return ResponseEntity + .status(e.getStatus().getStatusCode()) + .body(BaseResponse.error(ErrorResponse.of(e))); + } + + @ExceptionHandler(ConstraintViolationException.class) + public ResponseEntity> constraintViolationExceptionHandler(ConstraintViolationException e) { + log.warn(400 + " " + e.getMessage()); + + return ResponseEntity + .status(400) + .body(BaseResponse.error(ErrorResponse.of(e))); + } + + @ExceptionHandler(NoResourceFoundException.class) + public ResponseEntity> noHandlerFoundExceptionHandler(NoResourceFoundException e) { + log.warn(404 + " " + e.getMessage()); + + return ResponseEntity + .status(404) + .body(BaseResponse.error(ErrorResponse.of(e))); + } +} \ No newline at end of file diff --git a/src/main/java/ktb/mason/be_assignment/global/config/PropertiesConfig.java b/src/main/java/ktb/mason/be_assignment/global/config/PropertiesConfig.java new file mode 100644 index 0000000..d23c56b --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/global/config/PropertiesConfig.java @@ -0,0 +1,9 @@ +package ktb.mason.be_assignment.global.config; + +import org.springframework.boot.context.properties.ConfigurationPropertiesScan; +import org.springframework.context.annotation.Configuration; + +@Configuration +@ConfigurationPropertiesScan(basePackages = "ktb.mason.be_assignment") +public class PropertiesConfig { +} \ No newline at end of file diff --git a/src/main/java/ktb/mason/be_assignment/global/config/QueryDSLConfig.java b/src/main/java/ktb/mason/be_assignment/global/config/QueryDSLConfig.java new file mode 100644 index 0000000..502efa6 --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/global/config/QueryDSLConfig.java @@ -0,0 +1,20 @@ +package ktb.mason.be_assignment.global.config; + +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +import com.querydsl.jpa.impl.JPAQueryFactory; + +import jakarta.persistence.EntityManager; +import lombok.RequiredArgsConstructor; + +@Configuration +@RequiredArgsConstructor +public class QueryDSLConfig { + private final EntityManager entityManager; + + @Bean + public JPAQueryFactory jpaQueryFactory() { + return new JPAQueryFactory(entityManager); + } +} \ No newline at end of file diff --git a/src/main/java/ktb/mason/be_assignment/global/properties/ApiProperties.java b/src/main/java/ktb/mason/be_assignment/global/properties/ApiProperties.java new file mode 100644 index 0000000..c44fdd0 --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/global/properties/ApiProperties.java @@ -0,0 +1,16 @@ +package ktb.mason.be_assignment.global.properties; + +import org.springframework.boot.context.properties.ConfigurationProperties; +import org.springframework.boot.context.properties.ConfigurationPropertiesBinding; + +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.ToString; + +@Getter @ToString +@AllArgsConstructor +@ConfigurationProperties(prefix = "api") +@ConfigurationPropertiesBinding +public class ApiProperties { + private final String key; +} \ No newline at end of file diff --git a/src/main/java/ktb/mason/be_assignment/global/validate/ApiKey.java b/src/main/java/ktb/mason/be_assignment/global/validate/ApiKey.java new file mode 100644 index 0000000..6ec4256 --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/global/validate/ApiKey.java @@ -0,0 +1,13 @@ +package ktb.mason.be_assignment.global.validate; + +import java.lang.annotation.*; + +import jakarta.validation.Constraint; +import jakarta.validation.Payload; + +@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER}) +@Retention(RetentionPolicy.RUNTIME) +@Documented +public @interface ApiKey { + +} \ No newline at end of file diff --git a/src/main/java/ktb/mason/be_assignment/global/validate/ApiKeyAspect.java b/src/main/java/ktb/mason/be_assignment/global/validate/ApiKeyAspect.java new file mode 100644 index 0000000..94f0daa --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/global/validate/ApiKeyAspect.java @@ -0,0 +1,33 @@ +package ktb.mason.be_assignment.global.validate; + +import jakarta.servlet.http.HttpServletRequest; +import ktb.mason.be_assignment.global.api.ApiException; +import ktb.mason.be_assignment.global.api.AppHttpStatus; +import ktb.mason.be_assignment.global.properties.ApiProperties; +import lombok.RequiredArgsConstructor; +import org.aspectj.lang.annotation.Aspect; +import org.aspectj.lang.annotation.Before; +import org.springframework.stereotype.Component; +import org.springframework.util.StringUtils; + +@Aspect +@Component +@RequiredArgsConstructor +public class ApiKeyAspect { + + private final HttpServletRequest request; + private final ApiProperties apiProperties; + + @Before("@annotation(ApiKey)") + public void validateApiKey() { + String apiKey = request.getHeader("x-api-key"); + + if (!StringUtils.hasText(apiKey)) { + throw new ApiException(AppHttpStatus.BAD_REQUEST); + } + + if (!apiProperties.getKey().equals(apiKey)) { + throw new ApiException(AppHttpStatus.FORBIDDEN); + } + } +} \ No newline at end of file diff --git a/src/main/java/ktb/mason/be_assignment/global/validate/Code.java b/src/main/java/ktb/mason/be_assignment/global/validate/Code.java new file mode 100644 index 0000000..8621223 --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/global/validate/Code.java @@ -0,0 +1,19 @@ +package ktb.mason.be_assignment.global.validate; + +import jakarta.validation.Constraint; +import jakarta.validation.Payload; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER}) +@Retention(RetentionPolicy.RUNTIME) +@Constraint(validatedBy = CodeValidator.class) +public @interface Code { + + String message() default ""; + Class[] groups() default { }; + Class[] payload() default { }; +} \ No newline at end of file diff --git a/src/main/java/ktb/mason/be_assignment/global/validate/CodeValidator.java b/src/main/java/ktb/mason/be_assignment/global/validate/CodeValidator.java new file mode 100644 index 0000000..ec68678 --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/global/validate/CodeValidator.java @@ -0,0 +1,20 @@ +package ktb.mason.be_assignment.global.validate; + +import jakarta.validation.ConstraintValidator; +import jakarta.validation.ConstraintValidatorContext; +import ktb.mason.be_assignment.global.api.AppHttpStatus; +import org.springframework.util.StringUtils; + +public class CodeValidator implements ConstraintValidator { + + @Override + public boolean isValid(String code, ConstraintValidatorContext context) { + if (!StringUtils.hasText(code)) { + context.disableDefaultConstraintViolation(); + context.buildConstraintViolationWithTemplate(AppHttpStatus.BLANK_NOT_ALLOWED.getMessage()).addConstraintViolation(); + return false; + } + + return true; + } +} \ No newline at end of file diff --git a/src/main/java/ktb/mason/be_assignment/global/validate/Date.java b/src/main/java/ktb/mason/be_assignment/global/validate/Date.java new file mode 100644 index 0000000..71cfedf --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/global/validate/Date.java @@ -0,0 +1,19 @@ +package ktb.mason.be_assignment.global.validate; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +import jakarta.validation.Constraint; +import jakarta.validation.Payload; + +@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER}) +@Retention(RetentionPolicy.RUNTIME) +@Constraint(validatedBy = DateValidator.class) +public @interface Date { + + String message() default ""; + Class[] groups() default { }; + Class[] payload() default { }; +} \ No newline at end of file diff --git a/src/main/java/ktb/mason/be_assignment/global/validate/DateValidator.java b/src/main/java/ktb/mason/be_assignment/global/validate/DateValidator.java new file mode 100644 index 0000000..7938389 --- /dev/null +++ b/src/main/java/ktb/mason/be_assignment/global/validate/DateValidator.java @@ -0,0 +1,42 @@ +package ktb.mason.be_assignment.global.validate; + +import java.text.ParseException; +import java.text.SimpleDateFormat; + +import jakarta.validation.ConstraintValidator; +import jakarta.validation.ConstraintValidatorContext; +import ktb.mason.be_assignment.global.api.AppHttpStatus; +import org.springframework.util.StringUtils; + +public class DateValidator implements ConstraintValidator { + private static final String DATE_PATTERN = "yyyy-MM-dd"; + private static final String DATETIME_PATTERN = "yyyy-MM-dd HH:mm:ss"; + + @Override + public boolean isValid(String date, ConstraintValidatorContext context) { + if (!StringUtils.hasText(date)) { + context.disableDefaultConstraintViolation(); + context.buildConstraintViolationWithTemplate(AppHttpStatus.BLANK_NOT_ALLOWED.getMessage()).addConstraintViolation(); + return false; + } + + if (!isValidFormat(date, DATE_PATTERN) && !isValidFormat(date, DATETIME_PATTERN)) { + context.disableDefaultConstraintViolation(); + context.buildConstraintViolationWithTemplate(AppHttpStatus.INVALID_DATE_FORMAT.getMessage()).addConstraintViolation(); + return false; + } + + return true; + } + + private boolean isValidFormat(String date, String pattern) { + SimpleDateFormat sdf = new SimpleDateFormat(pattern); + sdf.setLenient(false); // lenient 모드를 false로 설정하여 유효하지 않은 날짜를 허용하지 않음 + try { + sdf.parse(date); // 유효하지 않은 날짜 형식일 경우 ParseException이 발생함 + } catch (ParseException e) { + return false; // 유효하지 않은 날짜 형식 + } + return date.length() == pattern.length(); // 유효한 날짜 형식 + } +} \ No newline at end of file diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 0000000..d74c444 --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,3 @@ +spring: + profiles: + active: local diff --git a/src/test/java/ktb/mason/be_assignment/domain/stock/service/StockServiceTest.java b/src/test/java/ktb/mason/be_assignment/domain/stock/service/StockServiceTest.java new file mode 100644 index 0000000..b24ce5b --- /dev/null +++ b/src/test/java/ktb/mason/be_assignment/domain/stock/service/StockServiceTest.java @@ -0,0 +1,84 @@ +package ktb.mason.be_assignment.domain.stock.service; + +import ktb.mason.be_assignment.domain.stock.controller.response.StockInfoResponse; +import ktb.mason.be_assignment.domain.stock.domain.Company; +import ktb.mason.be_assignment.domain.stock.domain.StockHistory; +import ktb.mason.be_assignment.global.api.ApiException; +import ktb.mason.be_assignment.global.api.AppHttpStatus; +import ktb.mason.be_assignment.mock.TestContainer; +import org.junit.jupiter.api.Test; + +import java.time.LocalDate; +import java.util.List; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.junit.jupiter.api.Assertions.*; + +class StockServiceTest { + + /** + * getStockInfoByCompanyCode + */ + @Test + void 기업의_종가_정보를_조회할_때_존재하지_않는_기업코드인_경우_조회할_수_없다() { + // given + TestContainer tc = TestContainer.builder().build(); + tc.fakeCompanyRepository.save(Company.builder() + .companyCode("AAPL") + .companyName("Apple Inc.") + .build()); + + // when + ApiException result = assertThrows( + ApiException.class, + () -> tc.stockService.getStockInfoByCompanyCode( + "AMD", + "2020-01-02", + "2020-01-03" + ) + ); + + // then + assertThat(result.getStatus()).isEqualTo(AppHttpStatus.NOT_FOUND_COMPANY); + } + + @Test + void 기업의_종가_정보를_조회할_수_있다() { + // given + TestContainer tc = TestContainer.builder().build(); + tc.fakeCompanyRepository.save(Company.builder() + .companyCode("AAPL") + .companyName("Apple Inc.") + .build()); + + tc.fakeStockHistoryRepository.saveAll(List.of( + StockHistory.builder() + .closePrice(72.7161) + .companyCode("AAPL") + .tradeDate(LocalDate.of(2020, 1, 2)) + .build(), + StockHistory.builder() + .closePrice(72.0091) + .companyCode("AAPL") + .tradeDate(LocalDate.of(2020, 1, 3)) + .build() + )); + + // when + StockInfoResponse result = tc.stockService.getStockInfoByCompanyCode( + "AAPL", + "2020-01-02", + "2020-01-03" + ); + + // then + assertAll( + () -> assertThat(result.getCompany().getCode()).isEqualTo("AAPL"), + () -> assertThat(result.getCompany().getName()).isEqualTo("Apple Inc."), + () -> assertThat(result.getStockHistories().size()).isEqualTo(2), + () -> assertThat(result.getStockHistories().get(0).getClosePrice()).isEqualTo(72.7161), + () -> assertThat(result.getStockHistories().get(0).getTradeDate()).isEqualTo(LocalDate.of(2020, 1, 2)) + + ); + } +} \ No newline at end of file diff --git a/src/test/java/ktb/mason/be_assignment/mock/FakeCompanyRepository.java b/src/test/java/ktb/mason/be_assignment/mock/FakeCompanyRepository.java new file mode 100644 index 0000000..5f811ef --- /dev/null +++ b/src/test/java/ktb/mason/be_assignment/mock/FakeCompanyRepository.java @@ -0,0 +1,23 @@ +package ktb.mason.be_assignment.mock; + +import ktb.mason.be_assignment.domain.stock.domain.Company; +import ktb.mason.be_assignment.domain.stock.service.port.CompanyRepository; + +import java.util.*; + +public class FakeCompanyRepository implements CompanyRepository { + private final List data = Collections.synchronizedList(new ArrayList<>()); + + public Company save(Company company) { + data.removeIf(item -> Objects.equals(item.getCompanyCode(), company.getCompanyCode())); + data.add(company); + return company; + } + + @Override + public Optional findByCompanyCode(String companyCode) { + return data.stream() + .filter(c -> c.getCompanyCode().equals(companyCode)) + .findAny(); + } +} \ No newline at end of file diff --git a/src/test/java/ktb/mason/be_assignment/mock/FakeStockHistoryRepository.java b/src/test/java/ktb/mason/be_assignment/mock/FakeStockHistoryRepository.java new file mode 100644 index 0000000..2a133cc --- /dev/null +++ b/src/test/java/ktb/mason/be_assignment/mock/FakeStockHistoryRepository.java @@ -0,0 +1,47 @@ +package ktb.mason.be_assignment.mock; + +import ktb.mason.be_assignment.domain.stock.domain.StockHistory; +import ktb.mason.be_assignment.domain.stock.service.port.StockHistoryRepository; + +import java.time.LocalDate; +import java.util.*; + +public class FakeStockHistoryRepository implements StockHistoryRepository { + private final List data = Collections.synchronizedList(new ArrayList<>()); + + public StockHistory save(StockHistory stockHistory) { + data.removeIf(item -> Objects.equals(item.getCompanyCode(), stockHistory.getCompanyCode())); + data.add(stockHistory); + return stockHistory; + } + + public List saveAll(List stockHistories) { + stockHistories.forEach(stockHistory -> + data.removeIf(item -> Objects.equals(item.getCompanyCode(), stockHistory.getCompanyCode())) + ); + // 새 데이터 추가 + data.addAll(stockHistories); + + return stockHistories; + } + + @Override + public List findAllByCompanyAndDateRange(String companyCode, String startDate, String endDate) { + return data.stream() + .filter(s -> byCompanyCodeAndDate(companyCode, startDate, endDate, s)) + .toList(); + } + + private boolean byCompanyCodeAndDate(String companyCode, String startDate, String endDate, StockHistory stockHistory) { + if(companyCode == null || startDate == null || endDate == null) return false; + + LocalDate s = LocalDate.parse(startDate); + LocalDate e = LocalDate.parse(endDate); + + return stockHistory.getCompanyCode().equals(companyCode) + && !stockHistory.getTradeDate().isBefore(s) + && !stockHistory.getTradeDate().isAfter(e); + } + + +} \ No newline at end of file diff --git a/src/test/java/ktb/mason/be_assignment/mock/TestContainer.java b/src/test/java/ktb/mason/be_assignment/mock/TestContainer.java new file mode 100644 index 0000000..83e923a --- /dev/null +++ b/src/test/java/ktb/mason/be_assignment/mock/TestContainer.java @@ -0,0 +1,21 @@ +package ktb.mason.be_assignment.mock; + +import ktb.mason.be_assignment.domain.stock.controller.port.StockService; +import ktb.mason.be_assignment.domain.stock.service.StockServiceImpl; +import lombok.Builder; + +public class TestContainer { + public final FakeStockHistoryRepository fakeStockHistoryRepository; + public final FakeCompanyRepository fakeCompanyRepository; + public final StockService stockService; + + @Builder + public TestContainer() { + fakeStockHistoryRepository = new FakeStockHistoryRepository(); + fakeCompanyRepository = new FakeCompanyRepository(); + this.stockService = StockServiceImpl.builder() + .stockHistoryRepository(fakeStockHistoryRepository) + .companyRepository(fakeCompanyRepository) + .build(); + } +}