release: v0.0.1 (#33)

* feat: 도메인 엔티티 생성 (#2)

* feat/#1: BaseTimeEntity 생성

* feat/#1: Contact Entity 생성

* feat/#1: Store Entity 생성

* feat/#1: Recommendation Entity 생성

* feat/#1: StoreImage Entity 생성

* feat/#1: Theme Entity 생성

* feat/#1: SongForm Entity 생성

* chore/#1: 테스트 커버리지 측정 제외 설정 (제거 예정)

* chore/#1: sonarCloud projectKey 수정

* chore: 서브 모듈 패키지명 변경

* feat: 메인 페이지 매장 목록 조회 API 구현 (#8)

* feat/#3: StoreRepository.findAllByOrderByCreatedAtAsc 구현

* feat/#3: StoreService.findSimpleStores 구현

* feat/#3: stores 정렬 기준을 storeId 로 변경

* feat/#3: DataBaseCleaner 구현

* feat/#3: StoreController.findSimpleStores 구현

* feat/#3: test application.yml 추가

* feat/#3: 테스트 커버리지 대상에 domain 패키지 추가

* feat/#3: 테스트 커버리지 대상에 vo 패키지 제외

* chore: jacoco 레포트를 sonarcloud 에 반영 (#10)

* chore/#9: jacoco 레포트를 sonarcloud 에 반영

* chore/#9: ci run 에 jacocoTestReport 추가

* feat: 매장 목록 조회 API 구현 (#11)

* feat/#4: StoreRepository.findAllByRegionOrderByStoreIdAsc 구현

* feat/#4: StoreService.findStores 구현

* feat/#4: Store 에 Theme, SongForm 정보 추가

* feat/#4: StoreController.storeService 구현

* feat/#4: jacocoExcludePatterns 추가

* feat/#4: jacoco 설정 변경

* feat: 음악 추천 API 구현 (#12)

* feat/#5: PhoneNumber 생성

* feat/#5: RecommendationInformation 생성

* feat/#5: Recommendation 생성

* feat/#5: RecommendationRepository 생성

* feat/#5: RecommendationService.registerRecommendation 구현

* feat/#5: RecommendationController.registerRecommendation 구현

* feat/#5: 테스트 커버리지 대상에 recommendation 패키지 추가

* feat: 문의 API 구현 (#13)

* feat/#6: ContactUserName 생성

* feat/#6: ContactContent 생성

* feat/#6: Contact 생성

* feat/#6: ContactRepository 생성

* feat/#6: ContactService.registerContact 구현

* feat/#6: ContactController.registerContact 구현

* feat/#6: 테스트 커버리지 대상에 contact 패키지 추가

* feat: 문의 등록, 음악 추천 메일 푸쉬 알림 기능 구현 (#14)

* feat/#7: MailService.sendMail 구현

* feat/#7: 문의 등록, 음악 추천 요청 시 이메일 알림 전송 기능 추가

* chore: dev, prod profile 설정 (#16)

* chore: 개발 서버 배포 스크립트 작성 (#18)

* chore/#17: 배포 스크립트 작성

* chore/#17: CD 설정

* chore: CodeDeploy 설정파일 변경 (#20)

* chore: appspec.yml 오타 수정

* chore: owner 수정

* chore: 배포 스크립트 수정

* chore: 배포 스크립트 수정

* docs: API 문서화 (#23)

* docs/#21: RestDocs 의존성 추가 및 BaseControllerTest 생성

* docs/#21: Controller 테스트 코드 작성 및 문서화

* docs/#21: 주석 제거

* docs/#21: index.html 생성

* chore: 배포 스크립트 수정 (#25)

* refactor/#22: 메일 푸쉬 알림 분리 (#27)

* refactor/#22: MailSendEvent, MailSendListener 생성

* refactor/#22: AsyncConfig 생성

* refactor/#22: SpringMailService.sendMail @async 적용 및 재시도 메카니즘 구현

* refactor/#22: EventPublisher 를 사용한 메일 메서드 호출

* refactor/#22: 메일 전송 재시도 테스트 코드 추가

* feat: 알림(Notification) 엔티티 생성 (#28)

* chore: 로그에 시간이 나오도록 배포 스트립트 수정 (#30)

* chore: 배포 환경 설정 (#32)

.github/workflows/cd.yml

@@ -0,0 +1,56 @@
+name: CD
+
+on:
+  push:
+    branches: [ "main" ]
+
+env:
+  S3_BUCKET_NAME: verby-bucket
+  PROJECT_NAME: indp-server
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.ACTIONS_TOKEN }}
+          submodules: true
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'zulu'
+
+      - name: Build with Gradle
+        run: ./gradlew clean build
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+
+      - name: Make zip file
+        run: zip -r ./$GITHUB_SHA.zip .
+        shell: bash
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          aws-region: ap-northeast-2
+          aws-access-key-id: ${{ secrets.AWS_ACCESS }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS }}
+
+      - name: Upload to S3
+        run: aws s3 cp --region ap-northeast-2 ./$GITHUB_SHA.zip s3://$S3_BUCKET_NAME/$PROJECT_NAME/$GITHUB_SHA.zip
+
+      - name: Code Deploy
+        run: |
+          aws deploy create-deployment \
+            --application-name verby-deploy \
+            --deployment-config-name CodeDeployDefault.AllAtOnce \
+            --deployment-group-name verby-dev \
+            --s3-location bucket=$S3_BUCKET_NAME,bundleType=zip,key=$PROJECT_NAME/$GITHUB_SHA.zip \

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "src/main/resources/sever-secrets"]
-	path = src/main/resources/sever-secrets
-	url = https://github.com/team-verby/sever-secrets.git
+[submodule "src/main/resources/server-secrets"]
+	path = src/main/resources/server-secrets
+	url = https://github.com/team-verby/server-secrets.git

appspec.yml

@@ -0,0 +1,18 @@
+version: 0.0
+os: linux
+files:
+  - source: /
+    destination: /home/ubuntu/app/indp-server
+    overwrite: true
+
+permissions:
+  - object: /
+    pattern: "**"
+    owner: ubuntu
+    group: ubuntu
+
+hooks:
+  ApplicationStart:
+    - location: scripts/deploy.sh
+      timeout: 180
+      runas: ubuntu

build.gradle

@@ -5,6 +5,8 @@ plugins {
 
 	id "org.sonarqube" version "4.4.1.3373"
 	id 'jacoco'
+
+	id "org.asciidoctor.jvm.convert" version "3.3.2"
 }
 
 group = 'com.verby'
@@ -18,6 +20,7 @@ configurations {
 	compileOnly {
 		extendsFrom annotationProcessor
 	}
+	asciidoctorExt
 }
 
 repositories {
@@ -32,13 +35,54 @@ dependencies {
 	runtimeOnly 'com.h2database:h2'
 	annotationProcessor 'org.projectlombok:lombok'
 	testImplementation 'org.springframework.boot:spring-boot-starter-test'
+	implementation 'io.rest-assured:rest-assured:5.4.0'
+	implementation 'org.springframework.boot:spring-boot-starter-mail:3.2.2'
+
+	asciidoctorExt 'org.springframework.restdocs:spring-restdocs-asciidoctor'
+	testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'
 }
 
 test {
 	useJUnitPlatform()
 	finalizedBy 'jacocoTestReport'
 }
 
+// RestDocs
+ext {
+	snippetsDir = file("build/generated-snippets")
+}
+
+test {
+	outputs.dir snippetsDir
+}
+
+asciidoctor {
+	inputs.dir snippetsDir
+	configurations 'asciidoctorExt'
+	dependsOn test
+}
+
+asciidoctor.doFirst {
+	delete file('src/main/resources/static/docs')
+}
+
+task copyDocument(type: Copy) {
+	dependsOn asciidoctor
+	from file("build/docs/asciidoc")
+	into file("src/main/resources/static/docs")
+}
+
+build {
+	dependsOn copyDocument
+}
+
+bootJar {
+	dependsOn asciidoctor
+	from("${asciidoctor.outputDir}/html5") {
+		into 'static/docs'
+	}
+}
+
 // Jacoco
 def jacocoDir = layout.buildDirectory.dir("reports/")
 
@@ -55,7 +99,8 @@ def jacocoExcludePatterns = [
 		"**/*Interceptor*",
 		"**/*Filter*",
 		"**/*Resolver*",
-		"**/resources/**"
+		"**/resources/**",
+		"**/common/**"
 ]
 
 def excludedClassFilesForReport(classDirectories, jacocoExcludePatterns) {
@@ -106,7 +151,7 @@ jacocoTestCoverageVerification {
 // SonarCloud
 sonar {
 	properties {
-		property "sonar.projectKey", "team-verby_test-repository"
+		property "sonar.projectKey", "team-verby_indp-server"
 		property "sonar.organization", "team-verby"
 		property "sonar.host.url", "https://sonarcloud.io"
 		property "sonar.exclusions", jacocoExcludePatterns.join(",")

scripts/deploy.sh

@@ -0,0 +1,35 @@
+PROJECT_ROOT=/home/ubuntu/app
+PROJECT_NAME=indp-server
+APPLICATION_NAME=indp
+
+DEPLOY_PATH=$PROJECT_ROOT/deploy
+
+APP_LOG=$DEPLOY_PATH/application.log
+ERROR_LOG=$DEPLOY_PATH/deploy-error.log
+DEPLOY_LOG=$DEPLOY_PATH/deploy.log
+
+mkdir $DEPLOY_PATH
+
+echo "------------------------------------------------------------------------------------" >> $DEPLOY_LOG
+
+echo "[ $(date +%c) ] Build 파일 복사" >> $DEPLOY_LOG
+cp $PROJECT_ROOT/$PROJECT_NAME/build/libs/*.jar $DEPLOY_PATH/
+
+echo "[ $(date +%c) ] 현재 구동 중인 애플리케이션 pid 확인" >> $DEPLOY_LOG
+CURRENT_PID=$(pgrep -f $APPLICATION_NAME)
+
+echo "[ $(date +%c) ] 현재 구동 중인 애플리케이션 pid: $CURRENT_PID" >> $DEPLOY_LOG
+if [ -z "$CURRENT_PID" ]; then
+        echo "[ $(date +%c) ] 현재 구동 중인 애플리케이션이 없으므로 종료하지 않습니다." >> $DEPLOY_LOG
+else
+        echo "[ $(date +%c) ] kill -15 $CURRENT_PID" >> $DEPLOY_LOG
+        kill -15 "$CURRENT_PID"
+        sleep 5
+fi
+
+echo "[ $(date +%c) ] 새 어플리케이션 배포" >> $DEPLOY_LOG
+
+JAR_NAME=$(ls -tr "$DEPLOY_PATH" | grep jar | tail -n 1)
+
+echo "[ $(date +%c) ] JAR Name: $JAR_NAME" >> $DEPLOY_LOG
+nohup java -jar $DEPLOY_PATH/"$JAR_NAME" --spring.profiles.active=prod > $APP_LOG 2> $ERROR_LOG &

src/docs/asciidoc/index.adoc

@@ -0,0 +1,52 @@
+= Indp Application API Document
+:doctype: book
+:source-highlighter: highlightjs
+:sectlinks:
+:toc: left
+:toclevels: 3
+
+== 매장 (Store)
+
+=== 매장 목록 조회 (간단 정보)
+
+==== Request
+
+operation::store-controller-test/find-simple-stores[snippets='http-request,query-parameters']
+
+==== Response
+
+operation::store-controller-test/find-simple-stores[snippets='http-response,response-fields']
+
+=== 매장 목록 조회
+
+==== Request
+
+operation::store-controller-test/find-stores[snippets='http-request,query-parameters']
+
+==== Response
+
+operation::store-controller-test/find-stores[snippets='http-response,response-fields']
+
+== 음악 추천 (Recommendation)
+
+=== 음악 추천하기
+
+==== Request
+
+operation::recommendation-controller-test/register-recommendation[snippets='http-request,request-fields']
+
+==== Response
+
+operation::recommendation-controller-test/register-recommendation[snippets='http-response,response-headers']
+
+== 문의 (Contact)
+
+=== 문의하기
+
+==== Request
+
+operation::contact-controller-test/register-contact[snippets='http-request,request-fields']
+
+==== Response
+
+operation::contact-controller-test/register-contact[snippets='http-response,response-headers']

src/main/java/com/verby/indp/domain/common/dto/PageInfo.java

@@ -0,0 +1,5 @@
+package com.verby.indp.domain.common.dto;
+
+public record PageInfo(long totalElements, boolean hasNext) {
+
+}

src/main/java/com/verby/indp/domain/common/entity/BaseTimeEntity.java

@@ -0,0 +1,18 @@
+package com.verby.indp.domain.common.entity;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.EntityListeners;
+import jakarta.persistence.MappedSuperclass;
+import java.time.LocalDateTime;
+import org.springframework.data.annotation.CreatedDate;
+import org.springframework.data.jpa.domain.support.AuditingEntityListener;
+
+@MappedSuperclass
+@EntityListeners(AuditingEntityListener.class)
+public abstract class BaseTimeEntity {
+
+    @CreatedDate
+    @Column(name = "created_at", updatable = false)
+    protected LocalDateTime createdAt;
+
+}

src/main/java/com/verby/indp/domain/common/event/MailSendEvent.java

@@ -0,0 +1,8 @@
+package com.verby.indp.domain.common.event;
+
+import com.verby.indp.domain.notification.dto.Mail;
+
+public record MailSendEvent(
+    Mail mail
+) {
+}

src/main/java/com/verby/indp/domain/common/vo/Address.java

@@ -0,0 +1,18 @@
+package com.verby.indp.domain.common.vo;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.Embeddable;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@Getter
+@Embeddable
+@AllArgsConstructor
+@NoArgsConstructor(access = lombok.AccessLevel.PROTECTED)
+public class Address {
+
+    @Column(name = "address")
+    private String address;
+
+}

src/main/java/com/verby/indp/domain/common/vo/PhoneNumber.java

@@ -0,0 +1,51 @@
+package com.verby.indp.domain.common.vo;
+
+import static java.util.Objects.isNull;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.Embeddable;
+import java.util.Objects;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@Getter
+@Embeddable
+@NoArgsConstructor(access = lombok.AccessLevel.PROTECTED)
+public class PhoneNumber {
+
+    private static final String PHONE_NUMBER_PATTERN = "^[0-9]+$";
+    private static final int MAX_PHONE_NUMBER_SIZE = 50;
+
+    @Column(name = "phone_number")
+    private String phoneNumber;
+
+    public PhoneNumber(String phoneNumber) {
+        validatePhoneNumber(phoneNumber);
+
+        this.phoneNumber = phoneNumber;
+    }
+
+    private void validatePhoneNumber(String phoneNumber) {
+        validateBlank(phoneNumber);
+        validateSize(phoneNumber);
+        validateValue(phoneNumber);
+    }
+
+    private void validateSize(String phoneNumber) {
+        if (phoneNumber.length() > MAX_PHONE_NUMBER_SIZE) {
+            throw new IllegalArgumentException("전화 번호의 크기는 최대 50자 입니다.");
+        }
+    }
+
+    private void validateValue(String phoneNumber) {
+        if (!phoneNumber.matches(PHONE_NUMBER_PATTERN)) {
+            throw new IllegalArgumentException("전화 번호는 숫자만 입력 가능합니다.");
+        }
+    }
+
+    private void validateBlank(String phoneNumber) {
+        if (isNull(phoneNumber) || phoneNumber.isBlank()) {
+            throw new IllegalArgumentException("전화 번호를 입력해주세요.");
+        }
+    }
+}