Added api prefix (#23)

Added api prefix, moved API controllers to api package, fixed coverage configuration.
Hexlet · Sep 13, 2019 · aa9314c · aa9314c
1 parent 89db368
commit aa9314c
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 39 deletions.
diff --git a/pom.xml b/pom.xml
@@ -19,8 +19,8 @@
 
         <!-- Code Coverage -->
         <jacoco-maven-plugin.version>0.8.4</jacoco-maven-plugin.version>
-        <jacoco-maven-plugin.lines-coverage-ratio>0.8</jacoco-maven-plugin.lines-coverage-ratio>
-        <jacoco-maven-plugin.methods-coverage-ratio>0.8</jacoco-maven-plugin.methods-coverage-ratio>
+        <jacoco-maven-plugin.lines-coverage-ratio>80%</jacoco-maven-plugin.lines-coverage-ratio>
+        <jacoco-maven-plugin.methods-coverage-ratio>80%</jacoco-maven-plugin.methods-coverage-ratio>
 
         <!-- Frontend -->
         <frontend-maven-plugin.version>1.8.0</frontend-maven-plugin.version>
@@ -228,7 +228,7 @@
                         <configuration>
                             <rules>
                                 <rule>
-                                    <element>PACKAGE</element>
+                                    <element>BUNDLE</element>
                                     <limits>
                                         <limit>
                                             <counter>LINE</counter>

diff --git a/src/main/java/io/hexlet/hexletcorrection/config/SwaggerConfig.java b/src/main/java/io/hexlet/hexletcorrection/config/SwaggerConfig.java
@@ -29,6 +29,6 @@ public Docket fullApi() {
     }
 
     private Predicate<RequestHandler> baseControllersPackage() {
-        return RequestHandlerSelectors.basePackage("io.hexlet.hexletcorrection.controller");
+        return RequestHandlerSelectors.basePackage("io.hexlet.hexletcorrection.controller.api");
     }
 }
diff --git a/src/main/java/io/hexlet/hexletcorrection/controller/ControllerConstants.java b/src/main/java/io/hexlet/hexletcorrection/controller/ControllerConstants.java
@@ -2,9 +2,11 @@
 
 public class ControllerConstants {
 
-    final static String TEST_HOST = "http://localhost";
+    public final static String TEST_HOST = "http://localhost";
 
-    final static String CORRECTIONS_PATH = "/corrections";
+    public final static String API_PATH_V1 = "/api/v1";
 
-    final static String ACCOUNTS_PATH = "/accounts";
+    public final static String CORRECTIONS_PATH = "/corrections";
+
+    public final static String ACCOUNTS_PATH = "/accounts";
 }
diff --git a/...rection/controller/AccountController.java → .../controller/api/v1/AccountController.java b/...rection/controller/AccountController.java → .../controller/api/v1/AccountController.java
@@ -1,4 +1,4 @@
-package io.hexlet.hexletcorrection.controller;
+package io.hexlet.hexletcorrection.controller.api.v1;
 
 import io.hexlet.hexletcorrection.controller.exception.AccountNotFoundException;
 import io.hexlet.hexletcorrection.domain.Account;
@@ -19,9 +19,10 @@
 import java.util.List;
 
 import static io.hexlet.hexletcorrection.controller.ControllerConstants.ACCOUNTS_PATH;
+import static io.hexlet.hexletcorrection.controller.ControllerConstants.API_PATH_V1;
 
 @RestController
-@RequestMapping(ACCOUNTS_PATH)
+@RequestMapping(API_PATH_V1 + ACCOUNTS_PATH)
 @AllArgsConstructor
 public class AccountController {
 

diff --git a/...tion/controller/CorrectionController.java → ...ntroller/api/v1/CorrectionController.java b/...tion/controller/CorrectionController.java → ...ntroller/api/v1/CorrectionController.java
@@ -1,4 +1,4 @@
-package io.hexlet.hexletcorrection.controller;
+package io.hexlet.hexletcorrection.controller.api.v1;
 
 import io.hexlet.hexletcorrection.controller.exception.CorrectionNotFoundException;
 import io.hexlet.hexletcorrection.domain.Correction;
@@ -18,10 +18,11 @@
 import javax.validation.Valid;
 import java.util.List;
 
+import static io.hexlet.hexletcorrection.controller.ControllerConstants.API_PATH_V1;
 import static io.hexlet.hexletcorrection.controller.ControllerConstants.CORRECTIONS_PATH;
 
 @RestController
-@RequestMapping(CORRECTIONS_PATH)
+@RequestMapping(API_PATH_V1 + CORRECTIONS_PATH)
 @RequiredArgsConstructor
 public class CorrectionController {
 

diff --git a/...ion/controller/AccountControllerTest.java → ...troller/api/v1/AccountControllerTest.java b/...ion/controller/AccountControllerTest.java → ...troller/api/v1/AccountControllerTest.java
@@ -1,4 +1,4 @@
-package io.hexlet.hexletcorrection.controller;
+package io.hexlet.hexletcorrection.controller.api.v1;
 
 import io.hexlet.hexletcorrection.domain.Account;
 import io.hexlet.hexletcorrection.service.AccountService;
@@ -11,8 +11,7 @@
 import org.springframework.http.HttpStatus;
 import org.springframework.test.context.junit4.SpringRunner;
 
-import static io.hexlet.hexletcorrection.controller.ControllerConstants.TEST_HOST;
-import static io.hexlet.hexletcorrection.controller.ControllerConstants.ACCOUNTS_PATH;
+import static io.hexlet.hexletcorrection.controller.ControllerConstants.*;
 import static io.hexlet.hexletcorrection.domain.EntityConstrainConstants.INVALID_EMAIL;
 import static io.hexlet.hexletcorrection.domain.EntityConstrainConstants.MAX_ACCOUNT_NAME;
 import static io.hexlet.hexletcorrection.domain.EntityConstrainConstants.NOT_EMPTY;
@@ -32,7 +31,7 @@ public class AccountControllerTest {
     @Test
     public void getAllAccountsTest() {
         given().when()
-                .get(TEST_HOST + ":" + port + ACCOUNTS_PATH)
+                .get(TEST_HOST + ":" + port + API_PATH_V1 + ACCOUNTS_PATH)
                 .then()
                 .statusCode(HttpStatus.OK.value())
                 .contentType(ContentType.JSON);
@@ -43,7 +42,7 @@ public void getAccountByIdTest() {
         Account account = createAccount();
 
         given().when()
-                .get(TEST_HOST + ":" + port + ACCOUNTS_PATH + "/" + account.getId())
+                .get(TEST_HOST + ":" + port + API_PATH_V1 + ACCOUNTS_PATH + "/" + account.getId())
                 .then()
                 .statusCode(HttpStatus.OK.value())
                 .contentType(ContentType.JSON);
@@ -54,7 +53,7 @@ public void getAccountByFalseIdTest() {
         long falseId = createAccount().getId() + 1L;
 
         given().when()
-                .get(TEST_HOST + ":" + port + ACCOUNTS_PATH + "/" + falseId)
+                .get(TEST_HOST + ":" + port + API_PATH_V1 + ACCOUNTS_PATH + "/" + falseId)
                 .then()
                 .statusCode(HttpStatus.NOT_FOUND.value())
                 .contentType(ContentType.JSON)
@@ -64,7 +63,7 @@ public void getAccountByFalseIdTest() {
     @Test
     public void getAccountByNameTest() {
         given().when()
-                .get(TEST_HOST + ":" + port + ACCOUNTS_PATH + "/?name=" + createAccount().getName())
+                .get(TEST_HOST + ":" + port + API_PATH_V1 + ACCOUNTS_PATH + "/?name=" + createAccount().getName())
                 .then()
                 .statusCode(HttpStatus.OK.value())
                 .contentType(ContentType.JSON);
@@ -75,7 +74,7 @@ public void getAccountByFalseNameTest() {
         String falseName = createAccount().getName() + "A";
 
         given().when()
-                .get(TEST_HOST + ":" + port + ACCOUNTS_PATH + "/?name=" + falseName)
+                .get(TEST_HOST + ":" + port + API_PATH_V1 + ACCOUNTS_PATH + "/?name=" + falseName)
                 .then()
                 .statusCode(HttpStatus.OK.value())
                 .contentType(ContentType.JSON);
@@ -91,7 +90,7 @@ public void postAccountTest() {
         given().when()
                 .body(account)
                 .contentType(ContentType.JSON)
-                .post(TEST_HOST + ":" + port + ACCOUNTS_PATH)
+                .post(TEST_HOST + ":" + port + API_PATH_V1 + ACCOUNTS_PATH)
                 .then()
                 .statusCode(HttpStatus.CREATED.value());
     }
@@ -105,7 +104,7 @@ public void postAccountNameEmptyTest() {
         given().when()
                 .body(account)
                 .contentType(ContentType.JSON)
-                .post(TEST_HOST + ":" + port + ACCOUNTS_PATH)
+                .post(TEST_HOST + ":" + port + API_PATH_V1 + ACCOUNTS_PATH)
                 .then()
                 .statusCode(HttpStatus.BAD_REQUEST.value())
                 .body("name", equalTo("Name " + NOT_EMPTY));
@@ -120,7 +119,7 @@ public void postAccountNameTooLongTest() {
         given().when()
                 .body(account)
                 .contentType(ContentType.JSON)
-                .post(TEST_HOST + ":" + port + ACCOUNTS_PATH)
+                .post(TEST_HOST + ":" + port + API_PATH_V1 + ACCOUNTS_PATH)
                 .then()
                 .statusCode(HttpStatus.BAD_REQUEST.value())
                 .body("name", equalTo("Name not be more than " + MAX_ACCOUNT_NAME + " characters"));
@@ -135,7 +134,7 @@ public void postAccountEmailEmptyTest() {
         given().when()
                 .body(account)
                 .contentType(ContentType.JSON)
-                .post(TEST_HOST + ":" + port + ACCOUNTS_PATH)
+                .post(TEST_HOST + ":" + port + API_PATH_V1 + ACCOUNTS_PATH)
                 .then()
                 .statusCode(HttpStatus.BAD_REQUEST.value())
                 .body("email", equalTo("Email " + NOT_EMPTY));
@@ -151,7 +150,7 @@ public void postAccountEmailInvalidTest() {
         given().when()
                 .body(account)
                 .contentType(ContentType.JSON)
-                .post(TEST_HOST + ":" + port + ACCOUNTS_PATH)
+                .post(TEST_HOST + ":" + port + API_PATH_V1 + ACCOUNTS_PATH)
                 .then()
                 .statusCode(HttpStatus.BAD_REQUEST.value())
                 .body("email", equalTo(INVALID_EMAIL));
@@ -162,7 +161,7 @@ public void deleteAccountTest() {
         Account account = createAccount();
 
         given().when()
-                .delete(TEST_HOST + ":" + port + ACCOUNTS_PATH + "/" + account.getId())
+                .delete(TEST_HOST + ":" + port + API_PATH_V1 + ACCOUNTS_PATH + "/" + account.getId())
                 .then()
                 .statusCode(HttpStatus.NO_CONTENT.value());
     }

diff --git a/.../controller/CorrectionControllerTest.java → ...ller/api/v1/CorrectionControllerTest.java b/.../controller/CorrectionControllerTest.java → ...ller/api/v1/CorrectionControllerTest.java
@@ -1,4 +1,4 @@
-package io.hexlet.hexletcorrection.controller;
+package io.hexlet.hexletcorrection.controller.api.v1;
 
 import io.hexlet.hexletcorrection.domain.Account;
 import io.hexlet.hexletcorrection.domain.Correction;
@@ -13,8 +13,7 @@
 import org.springframework.http.HttpStatus;
 import org.springframework.test.context.junit4.SpringRunner;
 
-import static io.hexlet.hexletcorrection.controller.ControllerConstants.CORRECTIONS_PATH;
-import static io.hexlet.hexletcorrection.controller.ControllerConstants.TEST_HOST;
+import static io.hexlet.hexletcorrection.controller.ControllerConstants.*;
 import static io.hexlet.hexletcorrection.domain.EntityConstrainConstants.MAX_COMMENT_LENGTH;
 import static io.hexlet.hexletcorrection.domain.EntityConstrainConstants.NOT_EMPTY;
 import static io.hexlet.hexletcorrection.domain.EntityConstrainConstants.NOT_NULL;
@@ -37,7 +36,7 @@ public class CorrectionControllerTest {
     @Test
     public void getAllCorrectionsTest() {
         given().when()
-                .get(TEST_HOST + ":" + port + CORRECTIONS_PATH)
+                .get(TEST_HOST + ":" + port + API_PATH_V1 + CORRECTIONS_PATH)
                 .then()
                 .statusCode(HttpStatus.OK.value())
                 .contentType(ContentType.JSON);
@@ -48,7 +47,7 @@ public void getCorrectionByIdTest() {
         Correction savedCorrection = createCorrection(createAccount());
 
         given().when()
-                .get(TEST_HOST + ":" + port + CORRECTIONS_PATH + "/" + savedCorrection.getId())
+                .get(TEST_HOST + ":" + port + API_PATH_V1 + CORRECTIONS_PATH + "/" + savedCorrection.getId())
                 .then()
                 .statusCode(HttpStatus.OK.value())
                 .contentType(ContentType.JSON);
@@ -59,7 +58,7 @@ public void getCorrectionByFalseIdTest() {
         long falseId = createCorrection(createAccount()).getId() + 1L;
 
         given().when()
-                .get(TEST_HOST + ":" + port + CORRECTIONS_PATH + "/" + falseId)
+                .get(TEST_HOST + ":" + port + API_PATH_V1 + CORRECTIONS_PATH + "/" + falseId)
                 .then()
                 .statusCode(HttpStatus.NOT_FOUND.value())
                 .contentType(ContentType.JSON)
@@ -71,7 +70,7 @@ public void getCorrectionByUrlTest() {
         Correction savedCorrection = createCorrection(createAccount());
 
         given().when()
-                .get(TEST_HOST + ":" + port + CORRECTIONS_PATH + "/?url=" + savedCorrection.getPageURL())
+                .get(TEST_HOST + ":" + port + API_PATH_V1 + CORRECTIONS_PATH + "/?url=" + savedCorrection.getPageURL())
                 .then()
                 .statusCode(HttpStatus.OK.value())
                 .contentType(ContentType.JSON);
@@ -91,7 +90,7 @@ public void postCorrectionTest() {
         given().when()
                 .body(correction)
                 .contentType(ContentType.JSON)
-                .post(TEST_HOST + ":" + port + CORRECTIONS_PATH)
+                .post(TEST_HOST + ":" + port + API_PATH_V1 + CORRECTIONS_PATH)
                 .then()
                 .statusCode(HttpStatus.CREATED.value());
     }
@@ -108,7 +107,7 @@ public void postCorrectionCommentEmptyTest() {
         given().when()
                 .body(correction)
                 .contentType(ContentType.JSON)
-                .post(TEST_HOST + ":" + port + CORRECTIONS_PATH)
+                .post(TEST_HOST + ":" + port + API_PATH_V1 + CORRECTIONS_PATH)
                 .then()
                 .statusCode(HttpStatus.BAD_REQUEST.value())
                 .body("comment", equalTo("Comment " + NOT_EMPTY));
@@ -126,7 +125,7 @@ public void postCorrectionCommentTooLongTest() {
         given().when()
                 .body(correction)
                 .contentType(ContentType.JSON)
-                .post(TEST_HOST + ":" + port + CORRECTIONS_PATH)
+                .post(TEST_HOST + ":" + port + API_PATH_V1 + CORRECTIONS_PATH)
                 .then()
                 .statusCode(HttpStatus.BAD_REQUEST.value())
                 .body("comment", equalTo("Comment not be more than " + MAX_COMMENT_LENGTH + " characters"));
@@ -144,7 +143,7 @@ public void postCorrectionHighlightTextEmptyTest() {
         given().when()
                 .body(correction)
                 .contentType(ContentType.JSON)
-                .post(TEST_HOST + ":" + port + CORRECTIONS_PATH)
+                .post(TEST_HOST + ":" + port + API_PATH_V1 + CORRECTIONS_PATH)
                 .then()
                 .statusCode(HttpStatus.BAD_REQUEST.value())
                 .body("highlightText", equalTo("Highlight text " + NOT_EMPTY));
@@ -161,7 +160,7 @@ public void postCorrectionAccountNullTest() {
         given().when()
                 .body(correction)
                 .contentType(ContentType.JSON)
-                .post(TEST_HOST + ":" + port + CORRECTIONS_PATH)
+                .post(TEST_HOST + ":" + port + API_PATH_V1 + CORRECTIONS_PATH)
                 .then()
                 .statusCode(HttpStatus.BAD_REQUEST.value())
                 .body("account", equalTo("Account " + NOT_NULL));
@@ -178,7 +177,7 @@ public void postCorrectionURLEmptyTest() {
         given().when()
                 .body(correction)
                 .contentType(ContentType.JSON)
-                .post(TEST_HOST + ":" + port + CORRECTIONS_PATH)
+                .post(TEST_HOST + ":" + port + API_PATH_V1 + CORRECTIONS_PATH)
                 .then()
                 .statusCode(HttpStatus.BAD_REQUEST.value())
                 .body("pageURL", equalTo("URL " + NOT_EMPTY));
@@ -189,7 +188,7 @@ public void deleteCorrectionTest() {
         Correction savedCorrection = createCorrection(createAccount());
 
         given().when()
-                .delete(TEST_HOST + ":" + port + CORRECTIONS_PATH + "/" + savedCorrection.getId())
+                .delete(TEST_HOST + ":" + port + API_PATH_V1 + CORRECTIONS_PATH + "/" + savedCorrection.getId())
                 .then()
                 .statusCode(HttpStatus.NO_CONTENT.value());
     }