Merge pull request #21 from TAMULib/sprint3-b03241-CRUD-for-notifications

Sprint3 b03241 crud for notifications

Author: tamu-sad-iii

src/main/java/edu/tamu/app/controller/NotificationController.java

@@ -8,7 +8,6 @@
 import static edu.tamu.framework.enums.BusinessValidationType.UPDATE;
 
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.messaging.simp.SimpMessagingTemplate;
 import org.springframework.web.bind.annotation.RestController;
 
 import edu.tamu.app.model.Notification;
@@ -27,16 +26,13 @@ public class NotificationController {
     @Autowired
     private NotificationRepo notificationRepo;
 
-    @Autowired
-    private SimpMessagingTemplate simpMessagingTemplate;
-    
     @ApiMapping("/all")
     @Auth(role="ROLE_STAFF")
     public ApiResponse getAllNotifications() {
         return new ApiResponse(SUCCESS, notificationRepo.findAll());
     }
 
-    @ApiMapping("/get/{id}")
+    @ApiMapping("/{id}")
     @Auth(role="ROLE_STAFF")
     public ApiResponse getNotification(@ApiVariable Long id) {
         return new ApiResponse(SUCCESS, notificationRepo.findOne(id));
@@ -46,17 +42,15 @@ public ApiResponse getNotification(@ApiVariable Long id) {
     @Auth(role="ROLE_WEB_MANAGER")
     @ApiValidation(business = { @ApiValidation.Business(value = CREATE), @ApiValidation.Business(value = EXISTS) })
     public ApiResponse create(@ApiValidatedModel Notification notification) {
-        notification = notificationRepo.create(notification.getName(), notification.getBody());
-        simpMessagingTemplate.convertAndSend("/channel/notification/", new ApiResponse(SUCCESS, notification));
+        notification = notificationRepo.create(notification.getName(), notification.getBody(), notification.getIsActive(), notification.getLocations());
         return new ApiResponse(SUCCESS, notification);
     }
 
     @ApiMapping("/update")
     @Auth(role="ROLE_WEB_MANAGER")
     @ApiValidation(business = { @ApiValidation.Business(value = UPDATE), @ApiValidation.Business(value = NONEXISTS) })
     public ApiResponse update(@ApiValidatedModel Notification notification) {
-        notification = notificationRepo.save(notification);
-        simpMessagingTemplate.convertAndSend("/channel/notification/", new ApiResponse(SUCCESS, notification));
+        notification = notificationRepo.update(notification);
         return new ApiResponse(SUCCESS, notification);
     }
 
@@ -65,7 +59,6 @@ public ApiResponse update(@ApiValidatedModel Notification notification) {
     @ApiValidation(business = { @ApiValidation.Business(value = DELETE), @ApiValidation.Business(value = NONEXISTS) })
     public ApiResponse remove(@ApiValidatedModel Notification notification) {
         notificationRepo.delete(notification);
-        simpMessagingTemplate.convertAndSend("/channel/notification/", new ApiResponse(SUCCESS, notificationRepo.findAll()));
         return new ApiResponse(SUCCESS);
     }
 }

src/main/java/edu/tamu/app/enums/NotificationLocation.java

@@ -0,0 +1,9 @@
+package edu.tamu.app.enums;
+
+public enum NotificationLocation {
+
+    EVANS,
+    CUSHING,
+    MSL,
+    WCL
+}

src/main/java/edu/tamu/app/model/Notification.java

@@ -1,28 +1,42 @@
 package edu.tamu.app.model;
 
+import static javax.persistence.FetchType.EAGER;
+
+import java.util.List;
+
 import javax.persistence.Column;
+import javax.persistence.ElementCollection;
 import javax.persistence.Entity;
-import javax.validation.constraints.Size;
 
+import edu.tamu.app.enums.NotificationLocation;
+import edu.tamu.app.model.validation.NotificationValidator;
 import edu.tamu.framework.model.BaseEntity;
 
 @Entity
 public class Notification extends BaseEntity {
 
-    @Size(min = 1)
     @Column(nullable = false)
     private String name;
 
-    @Size(min = 1)
     @Column(nullable = false)
     private String body;
 
-    public Notification() {}
+    @Column(nullable = false)
+    private boolean isActive;
+    
+    @ElementCollection(fetch = EAGER)
+    private List<NotificationLocation> locations; 
 
-    public Notification(String name, String body) {
+    public Notification() {
+        setModelValidator(new NotificationValidator());
+    }
+    
+    public Notification(String name, String body, boolean isActive, List<NotificationLocation> locations) {
         this();
         setName(name);
         setBody(body);
+        setIsActive(isActive);
+        setLocations(locations);
     }
 
     public String getName() {
@@ -40,4 +54,20 @@ public String getBody() {
     public void setBody(String body) {
         this.body = body;
     }
+
+    public Boolean getIsActive() {
+        return isActive;
+    }
+
+    public void setIsActive(Boolean isActive) {
+        this.isActive = isActive;
+    }
+
+    public List<NotificationLocation> getLocations() {
+        return locations;
+    }
+
+    public void setLocations(List<NotificationLocation> locations) {
+        this.locations = locations;
+    }
 }

src/main/java/edu/tamu/app/model/repo/NotificationRepo.java

@@ -6,5 +6,7 @@
 import edu.tamu.app.model.repo.custom.NotificationRepoCustom;
 
 public interface NotificationRepo extends JpaRepository<Notification, Long>, NotificationRepoCustom {
+    
+    public void delete(Notification notification);
 
 }

src/main/java/edu/tamu/app/model/repo/custom/NotificationRepoCustom.java

@@ -1,9 +1,16 @@
 package edu.tamu.app.model.repo.custom;
 
+import java.util.List;
+
+import edu.tamu.app.enums.NotificationLocation;
 import edu.tamu.app.model.Notification;
 
 public interface NotificationRepoCustom {
 
-    public Notification create(String name, String body);
+    public Notification create(String name, String body, boolean isActive, List<NotificationLocation> locations);
+    
+    public Notification update(Notification notification);
+    
+    public void delete(Notification notification);
 
 }

src/main/java/edu/tamu/app/model/repo/impl/NotificationRepoImpl.java

@@ -1,18 +1,43 @@
 package edu.tamu.app.model.repo.impl;
 
+import static edu.tamu.framework.enums.ApiResponseType.SUCCESS;
+
+import java.util.List;
+
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.messaging.simp.SimpMessagingTemplate;
 
+import edu.tamu.app.enums.NotificationLocation;
 import edu.tamu.app.model.Notification;
 import edu.tamu.app.model.repo.NotificationRepo;
 import edu.tamu.app.model.repo.custom.NotificationRepoCustom;
+import edu.tamu.framework.model.ApiResponse;
 
 public class NotificationRepoImpl implements NotificationRepoCustom {
 
     @Autowired
-    NotificationRepo notificationRepo;
+    private NotificationRepo notificationRepo;
+    
+    @Autowired
+    private SimpMessagingTemplate simpMessagingTemplate;
 
     @Override
-    public Notification create(String name, String body) {
-        return notificationRepo.save(new Notification(name, body));
+    public Notification create(String name, String body, boolean isActive, List<NotificationLocation> locations) {
+        Notification notification = notificationRepo.save(new Notification(name, body, isActive, locations));
+        simpMessagingTemplate.convertAndSend("/channel/notification/create", new ApiResponse(SUCCESS, notification));
+        return notification;
+    }
+    
+    @Override
+    public Notification update(Notification notification) {
+        notification = notificationRepo.save(notification);
+        simpMessagingTemplate.convertAndSend("/channel/notification/update", new ApiResponse(SUCCESS, notification));
+        return notification;
+    }
+    
+    @Override
+    public void delete(Notification notification) {
+        notificationRepo.delete(notification.getId());
+        simpMessagingTemplate.convertAndSend("/channel/notification/delete", new ApiResponse(SUCCESS, notification.getId()));
     }
 }

src/main/java/edu/tamu/app/model/validation/NotificationValidator.java

@@ -0,0 +1,25 @@
+package edu.tamu.app.model.validation;
+
+import edu.tamu.framework.enums.InputValidationType;
+import edu.tamu.framework.validation.BaseModelValidator;
+import edu.tamu.framework.validation.InputValidator;
+
+public class NotificationValidator extends BaseModelValidator {
+    
+    public NotificationValidator() {
+        String nameProperty = "name";
+        this.addInputValidator(new InputValidator(InputValidationType.required, "Notifications require a name", nameProperty, true));
+        this.addInputValidator(new InputValidator(InputValidationType.minlength, "Notification name must be at least 3 characters", nameProperty, 3));
+        
+        String bodyProperty = "body";
+        this.addInputValidator(new InputValidator(InputValidationType.required, "Notifications require a body", bodyProperty, true));
+        this.addInputValidator(new InputValidator(InputValidationType.minlength, "Notification body must be at least 3 characters", bodyProperty, 3));
+        this.addInputValidator(new InputValidator(InputValidationType.maxlength, "Notifications must be no more than 140 cahracters", bodyProperty, 140));
+        
+        String isActiveProperty = "isActive";
+        this.addInputValidator(new InputValidator(InputValidationType.required, "Notifcations must have a value for is active", isActiveProperty, true));
+        
+        String locationsProperty = "locations";
+        this.addInputValidator(new InputValidator(InputValidationType.required, "Notifications must have a display location", locationsProperty, true));
+    }
+}

src/test/java/controller/NotificationControllerTest.java

@@ -3,6 +3,7 @@
 import static edu.tamu.framework.enums.ApiResponseType.SUCCESS;
 import static org.junit.Assert.assertEquals;
 import static org.mockito.Matchers.any;
+import static org.mockito.Matchers.anyListOf;
 import static org.mockito.Mockito.doNothing;
 import static org.mockito.Mockito.when;
 
@@ -22,6 +23,7 @@
 import org.springframework.test.context.junit4.SpringRunner;
 
 import edu.tamu.app.controller.NotificationController;
+import edu.tamu.app.enums.NotificationLocation;
 import edu.tamu.app.model.Notification;
 import edu.tamu.app.model.repo.NotificationRepo;
 import edu.tamu.framework.model.ApiResponse;
@@ -38,11 +40,13 @@ public class NotificationControllerTest {
     protected static final String TEST_NOTIFICATION2_BODY = "Test Notification Body 2";
     protected static final String TEST_NOTIFICATION3_BODY = "Test Notification Body 3";
     protected static final String TEST_MODIFIED_NOTIFICATION_BODY = "Test Modified Notification Body";
+    protected static final boolean TEST_IS_ACTIVE = true;
+    protected static final List<NotificationLocation> TEST_LOCATIONS = Arrays.asList(new NotificationLocation[] {NotificationLocation.CUSHING});
 
-    protected static Notification TEST_NOTIFICATION1 = new Notification(TEST_NOTIFICATION1_NAME, TEST_NOTIFICATION1_BODY);
-    protected static Notification TEST_NOTIFICATION2= new Notification(TEST_NOTIFICATION2_NAME,TEST_NOTIFICATION2_BODY); 
-    protected static Notification TEST_NOTIFICATION3 = new Notification(TEST_NOTIFICATION3_NAME, TEST_NOTIFICATION3_BODY);
-    protected static Notification TEST_MODIFIED_NOTIFICATION = new Notification(TEST_MODIFIED_NOTIFICATION_NAME, TEST_NOTIFICATION2_BODY);
+    protected static Notification TEST_NOTIFICATION1 = new Notification(TEST_NOTIFICATION1_NAME, TEST_NOTIFICATION1_BODY, TEST_IS_ACTIVE, TEST_LOCATIONS);
+    protected static Notification TEST_NOTIFICATION2= new Notification(TEST_NOTIFICATION2_NAME,TEST_NOTIFICATION2_BODY, TEST_IS_ACTIVE, TEST_LOCATIONS); 
+    protected static Notification TEST_NOTIFICATION3 = new Notification(TEST_NOTIFICATION3_NAME, TEST_NOTIFICATION3_BODY, TEST_IS_ACTIVE, TEST_LOCATIONS);
+    protected static Notification TEST_MODIFIED_NOTIFICATION = new Notification(TEST_MODIFIED_NOTIFICATION_NAME, TEST_NOTIFICATION2_BODY, TEST_IS_ACTIVE, TEST_LOCATIONS);
 
     protected static List<Notification> mockNotificationList = new ArrayList<Notification>(Arrays.asList(new Notification[] { TEST_NOTIFICATION1, TEST_NOTIFICATION2, TEST_NOTIFICATION3 }));
 
@@ -63,8 +67,8 @@ public void setUp() {
 
         when(notificationRepo.findAll()).thenReturn(mockNotificationList);
         when(notificationRepo.findOne(any(Long.class))).thenReturn(TEST_NOTIFICATION1);
-        when(notificationRepo.create(any(String.class), any(String.class))).thenReturn(TEST_NOTIFICATION1);
-        when(notificationRepo.save(any(Notification.class))).thenReturn(TEST_MODIFIED_NOTIFICATION);
+        when(notificationRepo.create(any(String.class), any(String.class), any(boolean.class), anyListOf(NotificationLocation.class))).thenReturn(TEST_NOTIFICATION1);
+        when(notificationRepo.update(any(Notification.class))).thenReturn(TEST_MODIFIED_NOTIFICATION);
         doNothing().when(notificationRepo).delete(any(Notification.class));
     }
 

src/test/java/edu/tamu/app/model/NotificationTest.java

@@ -2,7 +2,8 @@
 
 import static org.junit.Assert.assertEquals;
 
-import javax.validation.ConstraintViolationException;
+import java.util.Arrays;
+import java.util.List;
 
 import org.junit.After;
 import org.junit.Test;
@@ -14,6 +15,7 @@
 import org.springframework.test.context.web.WebAppConfiguration;
 
 import edu.tamu.app.WebServerInit;
+import edu.tamu.app.enums.NotificationLocation;
 import edu.tamu.app.model.repo.NotificationRepo;
 
 @WebAppConfiguration
@@ -25,40 +27,32 @@ public class NotificationTest {
     protected static final String TEST_NOTIFICATION_BODY = "Test Notification Body";
     protected static final String TEST_ALTERNATE_NOTIFICATION_NAME = "Different Notification Name";
     protected static final String TEST_ALTERNATE_NOTIFICATION_BODY = "Different Notification Body";
+    protected static final boolean TEST_IS_ACTIVE = true;
+    protected static final List<NotificationLocation> TEST_LOCATIONS = Arrays.asList(new NotificationLocation[] {NotificationLocation.CUSHING});
 
     @Autowired
     NotificationRepo notificationRepo;
 
     @Test
     public void testCreate() {
         long initialCount = notificationRepo.count();
-        notificationRepo.create(TEST_NOTIFICATION_NAME, TEST_NOTIFICATION_BODY);
+        notificationRepo.create(TEST_NOTIFICATION_NAME, TEST_NOTIFICATION_BODY, TEST_IS_ACTIVE, TEST_LOCATIONS);
         assertEquals("The number of Notifications did not increase by one", initialCount + 1, notificationRepo.count());
     }
 
     @Test(expected = DataIntegrityViolationException.class)
     public void testNameNotNull() {
-        notificationRepo.create(null, TEST_NOTIFICATION_BODY);
+        notificationRepo.create(null, TEST_NOTIFICATION_BODY, TEST_IS_ACTIVE, TEST_LOCATIONS);
     }
 
     @Test(expected = DataIntegrityViolationException.class)
     public void testBodyNotNull() {
-        notificationRepo.create(TEST_NOTIFICATION_NAME, null);
-    }
-
-    @Test(expected = ConstraintViolationException.class)
-    public void testNameNotEmpty() {
-        notificationRepo.create("", TEST_NOTIFICATION_BODY);
-    }
-
-    @Test(expected = ConstraintViolationException.class)
-    public void testBodyNotEmpty() {
-        notificationRepo.create(TEST_NOTIFICATION_NAME, "");
+        notificationRepo.create(TEST_NOTIFICATION_NAME, null, TEST_IS_ACTIVE, TEST_LOCATIONS);
     }
 
     @Test
     public void testUpdateName() {
-       Notification notification = notificationRepo.create(TEST_NOTIFICATION_NAME, TEST_NOTIFICATION_BODY);
+       Notification notification = notificationRepo.create(TEST_NOTIFICATION_NAME, TEST_NOTIFICATION_BODY, TEST_IS_ACTIVE, TEST_LOCATIONS);
        notification.setName(TEST_ALTERNATE_NOTIFICATION_NAME);
        notificationRepo.save(notification);
        notification = notificationRepo.findOne(notification.getId());
@@ -67,17 +61,17 @@ public void testUpdateName() {
 
     @Test
     public void testUpdateBody() {
-       Notification notification = notificationRepo.create(TEST_NOTIFICATION_NAME, TEST_NOTIFICATION_BODY);
+       Notification notification = notificationRepo.create(TEST_NOTIFICATION_NAME, TEST_NOTIFICATION_BODY, TEST_IS_ACTIVE, TEST_LOCATIONS);
        notification.setBody(TEST_ALTERNATE_NOTIFICATION_BODY);
-       notificationRepo.save(notification);
+       notificationRepo.update(notification);
        notification = notificationRepo.findOne(notification.getId());
        assertEquals("Notification body was not changed", TEST_ALTERNATE_NOTIFICATION_BODY, notification.getBody());
     }
 
     @Test
     public void testDelete() {
         long initialCount = notificationRepo.count();
-        Notification notification = notificationRepo.create(TEST_NOTIFICATION_NAME, TEST_NOTIFICATION_BODY);
+        Notification notification = notificationRepo.create(TEST_NOTIFICATION_NAME, TEST_NOTIFICATION_BODY, TEST_IS_ACTIVE, TEST_LOCATIONS);
         assertEquals("Notification not created", initialCount + 1, notificationRepo.count());
         notificationRepo.delete(notification);
         assertEquals("Notification was not deleted", initialCount, notificationRepo.count());