From ded51b8b8d46f05f3a5320b7826f50b3c07984ae Mon Sep 17 00:00:00 2001 From: npole0103 Date: Thu, 20 Oct 2022 20:47:24 +0900 Subject: [PATCH 1/4] refactor: Modify create URI & download return type naming --- .../kr/markdown/alreadyme/controller/AppController.java | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/main/java/kr/markdown/alreadyme/controller/AppController.java b/src/main/java/kr/markdown/alreadyme/controller/AppController.java index 1a3c4ff..ed2e15c 100644 --- a/src/main/java/kr/markdown/alreadyme/controller/AppController.java +++ b/src/main/java/kr/markdown/alreadyme/controller/AppController.java @@ -2,7 +2,7 @@ import kr.markdown.alreadyme.domain.dto.ReadmeItemDto.Create; import kr.markdown.alreadyme.domain.dto.ReadmeItemDto.Request; -import kr.markdown.alreadyme.domain.dto.ReadmeItemDto.ObjectUrl; +import kr.markdown.alreadyme.domain.dto.ReadmeItemDto.Download; import kr.markdown.alreadyme.domain.dto.ReadmeItemDto.PullRequest; import kr.markdown.alreadyme.domain.model.ReadmeItem; import kr.markdown.alreadyme.service.AppService; @@ -19,7 +19,7 @@ public class AppController { public final AppService service; - @PostMapping + @PostMapping("readme") @ResponseStatus(HttpStatus.OK) public ReadmeItem post(@Valid @RequestBody Create createDto) throws Exception { return service.create(createDto); @@ -27,7 +27,7 @@ public ReadmeItem post(@Valid @RequestBody Create createDto) throws Exception { @PostMapping("download") @ResponseStatus(HttpStatus.OK) - public ObjectUrl download(@Valid @RequestBody Request requestDto) throws Exception { + public Download download(@Valid @RequestBody Request requestDto) throws Exception { return service.download(requestDto); } From d87f1cd8ae0e97ece506f72ad5c5f9fc2b81113a Mon Sep 17 00:00:00 2001 From: npole0103 Date: Thu, 20 Oct 2022 20:48:21 +0900 Subject: [PATCH 2/4] refactor: Modify download naming & Delete ResultDto --- .../alreadyme/domain/dto/ReadmeItemDto.java | 23 +------------------ 1 file changed, 1 insertion(+), 22 deletions(-) diff --git a/src/main/java/kr/markdown/alreadyme/domain/dto/ReadmeItemDto.java b/src/main/java/kr/markdown/alreadyme/domain/dto/ReadmeItemDto.java index c9a9f65..d0d7a86 100644 --- a/src/main/java/kr/markdown/alreadyme/domain/dto/ReadmeItemDto.java +++ b/src/main/java/kr/markdown/alreadyme/domain/dto/ReadmeItemDto.java @@ -36,7 +36,7 @@ class Request { @Builder @AllArgsConstructor @NoArgsConstructor - class ObjectUrl { + class Download { @NotBlank private String objectUrl; } @@ -64,25 +64,4 @@ class PullRequest { private String pullRequestUrl; } - @Getter - @Setter - @Builder - @AllArgsConstructor - @NoArgsConstructor - class Result { - @NotNull - private Long id; - - @NotBlank - @Pattern(regexp = "(?:https://)github.com[:/](.*).git") - private String githubOriginalUrl; - - @NotBlank - private String readmeText; - - private String objectUrl; - - @DateTimeFormat - private LocalDateTime createdTime; - } } From 94337312c1ea42bed35af674d7b666e1d72758f2 Mon Sep 17 00:00:00 2001 From: npole0103 Date: Thu, 20 Oct 2022 20:49:37 +0900 Subject: [PATCH 3/4] refactor: Modify DownloadDto naming & CreateReadme methods naming --- .../alreadyme/service/AppService.java | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/src/main/java/kr/markdown/alreadyme/service/AppService.java b/src/main/java/kr/markdown/alreadyme/service/AppService.java index 932c143..4bf0f10 100644 --- a/src/main/java/kr/markdown/alreadyme/service/AppService.java +++ b/src/main/java/kr/markdown/alreadyme/service/AppService.java @@ -4,7 +4,7 @@ import com.fasterxml.jackson.databind.node.ObjectNode; import kr.markdown.alreadyme.domain.dto.ReadmeItemDto.Create; import kr.markdown.alreadyme.domain.dto.ReadmeItemDto.Request; -import kr.markdown.alreadyme.domain.dto.ReadmeItemDto.ObjectUrl; +import kr.markdown.alreadyme.domain.dto.ReadmeItemDto.Download; import kr.markdown.alreadyme.domain.dto.ReadmeItemDto.PullRequest; import kr.markdown.alreadyme.domain.model.ReadmeItem; import kr.markdown.alreadyme.repository.ReadmeItemRepository; @@ -88,25 +88,25 @@ public ReadmeItem create(Create createDto) throws Exception { } @Transactional - public ObjectUrl download(Request requestDto) throws Exception { + public Download download(Request requestDto) throws Exception { - ObjectUrl objectUrlDto; + Download downloadDto; ReadmeItem readmeItem = findReadmeItemThrowException(requestDto.getId()); //If S3 link already exists if(readmeItem.getObjectUrl() != null) { - objectUrlDto = ObjectUrl.builder() + downloadDto = Download.builder() .objectUrl(readmeItem.getObjectUrl()) .build(); - return objectUrlDto; + return downloadDto; } - //Create README.md - File uploadFile = createDownloadReadme(readmeItem.getReadmeText()); + //Create README.md File + File uploadFile = createReadmeInDownload(readmeItem.getReadmeText()); //Upload README.md to S3-bucket String objectUrl = s3Service.upload(uploadFile, uploadFile.getParentFile().getName()); - objectUrlDto = ObjectUrl.builder() + downloadDto = Download.builder() .objectUrl(objectUrl) .build(); @@ -116,7 +116,7 @@ public ObjectUrl download(Request requestDto) throws Exception { //Delete Folder FileUtils.deleteDirectory(new File(uploadFile.getParentFile().getPath())); - return objectUrlDto; + return downloadDto; } public PullRequest pullRequest(Request requestDto) throws Exception { @@ -130,7 +130,7 @@ public PullRequest pullRequest(Request requestDto) throws Exception { Git git = JGitUtil.cloneRepository(githubBotUrl); //Create README.md - createPullRequestReadme( + createReadmeInPullRequest( git.getRepository().getDirectory().getPath() + File.separator + "..", readmeItem.getReadmeText() ); @@ -155,8 +155,8 @@ public PullRequest pullRequest(Request requestDto) throws Exception { return pullRequestDto; } - //create README.md - private void createPullRequestReadme(String localDirPath, String text) throws Exception { + //create README.md in pull-request + private void createReadmeInPullRequest(String localDirPath, String text) throws Exception { try { FileWriter output = new FileWriter(localDirPath + File.separator +"README.md"); output.write(text); @@ -166,8 +166,8 @@ private void createPullRequestReadme(String localDirPath, String text) throws Ex } } - //create download README.md - private File createDownloadReadme(String text) throws Exception { + //create README.md in download + private File createReadmeInDownload(String text) throws Exception { File file = new File(System.getProperty("user.dir") + File.separator + UUID.randomUUID() + File.separator + "README.md"); try { file.getParentFile().mkdirs(); From 8942763a97c74473ab29ab26727ff96ac411c319 Mon Sep 17 00:00:00 2001 From: npole0103 Date: Thu, 20 Oct 2022 20:50:55 +0900 Subject: [PATCH 4/4] chore: Fix typo in ErrorMessage --- .../kr/markdown/alreadyme/controller/ExceptionController.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/kr/markdown/alreadyme/controller/ExceptionController.java b/src/main/java/kr/markdown/alreadyme/controller/ExceptionController.java index f57802a..ffdb3a9 100644 --- a/src/main/java/kr/markdown/alreadyme/controller/ExceptionController.java +++ b/src/main/java/kr/markdown/alreadyme/controller/ExceptionController.java @@ -26,7 +26,7 @@ public ResponseEntity badRequestHandler(NoRemoteRepositoryException e) { Map error = new HashMap<>(); error.put("timestamp", new Date()); error.put("code", "400"); - error.put("message", "Error occured while cloning the repository. Check your github url."); + error.put("message", "Error occurred while cloning the repository. Check your github url."); return ResponseEntity.badRequest().body(error); } }