Implementing CCBProgressReporter

This reporter updates two pairs of user-defined fields on an Individual
Profile. The first pair are pulldown & date fields used to track the
assessment results. The second pair are updated after each chapter is
completed.

4 files changed, 316 insertions, 6 deletions

diff --git a/src/com/p4square/grow/ccb/CCBProgressReporter.java b/src/com/p4square/grow/ccb/CCBProgressReporter.java
index e2304fe..d2826eb 100644
--- a/src/com/p4square/grow/ccb/CCBProgressReporter.java
+++ b/src/com/p4square/grow/ccb/CCBProgressReporter.java
@@ -1,9 +1,15 @@
 package com.p4square.grow.ccb;
 
 import com.p4square.ccbapi.CCBAPI;
+import com.p4square.ccbapi.model.*;
 import com.p4square.grow.frontend.ProgressReporter;
+import com.p4square.grow.model.Score;
+import org.apache.log4j.Logger;
 import org.restlet.security.User;
 
+import java.io.IOException;
+import java.time.LocalDate;
+import java.time.ZoneId;
 import java.util.Date;
 
 /**
@@ -14,19 +20,85 @@ import java.util.Date;
  */
 public class CCBProgressReporter implements ProgressReporter {
 
+    private static final Logger LOG = Logger.getLogger(CCBProgressReporter.class);
+
+    private static final String GROW_LEVEL = "GrowLevelTrain";
+    private static final String GROW_ASSESSMENT = "GrowLevelAsmnt";
+
     private final CCBAPI mAPI;
+    private final CustomFieldCache mCache;
 
-    public CCBProgressReporter(final CCBAPI api) {
+    public CCBProgressReporter(final CCBAPI api, final CustomFieldCache cache) {
         mAPI = api;
+        mCache = cache;
     }
 
     @Override
-    public void reportAssessmentComplete(User user, String level, Date date, String results) {
-        // TODO
+    public void reportAssessmentComplete(final User user, final String level, final Date date, final String results) {
+        if (!(user instanceof CCBUser)) {
+            throw new IllegalArgumentException("Expected CCBUser but got " + user.getClass().getCanonicalName());
+        }
+        final CCBUser ccbuser = (CCBUser) user;
+
+        updateLevelAndDate(ccbuser, GROW_ASSESSMENT, level, date);
     }
 
     @Override
-    public void reportChapterComplete(User user, String chapter, Date date) {
-        // TODO
+    public void reportChapterComplete(final User user, final String chapter, final Date date) {
+        if (!(user instanceof CCBUser)) {
+            throw new IllegalArgumentException("Expected CCBUser but got " + user.getClass().getCanonicalName());
+        }
+        final CCBUser ccbuser = (CCBUser) user;
+
+        // Only update the level if it is increasing.
+        final CustomPulldownFieldValue currentLevel = ccbuser.getProfile()
+                .getCustomPulldownFields().getByLabel(GROW_LEVEL);
+
+        if (currentLevel != null) {
+            if (Score.numericScore(chapter) <= Score.numericScore(currentLevel.getSelection().getLabel())) {
+                LOG.info("Not updating level for " + user.getIdentifier()
+                        + " because current level (" + currentLevel.getSelection().getLabel()
+                        + ") is greater than new level (" + chapter + ")");
+                return;
+            }
+        }
+
+        updateLevelAndDate(ccbuser, GROW_LEVEL, chapter, date);
+    }
+
+    private void updateLevelAndDate(final CCBUser user, final String field, final String level, final Date date) {
+        boolean modified = false;
+
+        final UpdateIndividualProfileRequest req = new UpdateIndividualProfileRequest()
+                .withIndividualId(user.getProfile().getId());
+
+        final CustomField pulldownField = mCache.getIndividualPulldownByLabel(field);
+        if (pulldownField != null) {
+            final LookupTableType type = LookupTableType.valueOf(pulldownField.getName().toUpperCase());
+            final LookupTableItem item = mCache.getPulldownItemByName(type, level);
+            if (item != null) {
+                req.withCustomPulldownField(pulldownField.getName(), item.getId());
+                modified = true;
+            }
+        }
+
+        final CustomField dateField = mCache.getDateFieldByLabel(field);
+        if (dateField != null) {
+            req.withCustomDateField(dateField.getName(), date.toInstant().atZone(ZoneId.systemDefault()).toLocalDate());
+            modified = true;
+        }
+
+        try {
+            // Only update if a field exists.
+            if (modified) {
+                mAPI.updateIndividualProfile(req);
+            }
+
+        } catch (IOException e) {
+            LOG.error("updateIndividual failed for " + user.getIdentifier()
+                    + ", field " + field
+                    + ", level " + level
+                    + ", date " + date.toString());
+        }
     }
 }
diff --git a/src/com/p4square/grow/ccb/ChurchCommunityBuilderIntegrationDriver.java b/src/com/p4square/grow/ccb/ChurchCommunityBuilderIntegrationDriver.java
index 48d143c..fc6148f 100644
--- a/src/com/p4square/grow/ccb/ChurchCommunityBuilderIntegrationDriver.java
+++ b/src/com/p4square/grow/ccb/ChurchCommunityBuilderIntegrationDriver.java
@@ -41,7 +41,8 @@ public class ChurchCommunityBuilderIntegrationDriver implements IntegrationDrive
 
             mAPI = api;
 
-            mProgressReporter = new CCBProgressReporter(mAPI);
+            final CustomFieldCache cache = new CustomFieldCache(mAPI);
+            mProgressReporter = new CCBProgressReporter(mAPI, cache);
 
         } catch (URISyntaxException e) {
             throw new RuntimeException(e);
diff --git a/src/com/p4square/grow/model/Score.java b/src/com/p4square/grow/model/Score.java
index 82f26c9..031c309 100644
--- a/src/com/p4square/grow/model/Score.java
+++ b/src/com/p4square/grow/model/Score.java
@@ -17,6 +17,8 @@ public class Score {
      *  numericScore(x.toString()) <= x.getScore()
      */
     public static double numericScore(String score) {
+        score = score.toLowerCase();
+
         if ("teacher".equals(score)) {
             return 3.5;
         } else if ("disciple".equals(score)) {
diff --git a/tst/com/p4square/grow/ccb/CCBProgressReporterTest.java b/tst/com/p4square/grow/ccb/CCBProgressReporterTest.java
new file mode 100644
index 0000000..6854f22
--- /dev/null
+++ b/tst/com/p4square/grow/ccb/CCBProgressReporterTest.java
@@ -0,0 +1,235 @@
+package com.p4square.grow.ccb;
+
+import com.p4square.ccbapi.CCBAPI;
+import com.p4square.ccbapi.model.*;
+import org.easymock.Capture;
+import org.easymock.EasyMock;
+import org.junit.Before;
+import org.junit.Test;
+
+import java.time.LocalDate;
+import java.util.Date;
+
+import static org.junit.Assert.*;
+
+/**
+ * Tests for the CCBProgressReporter.
+ */
+public class CCBProgressReporterTest {
+
+    private static final String GROW_LEVEL = "GrowLevelTrain";
+    private static final String ASSESSMENT_LEVEL = "GrowLevelAsmnt";
+
+    private CCBProgressReporter reporter;
+
+    private CCBAPI api;
+    private CustomFieldCache cache;
+
+    private CCBUser user;
+    private Date date;
+
+    @Before
+    public void setUp() {
+        // Setup some data for testing.
+        IndividualProfile profile = new IndividualProfile();
+        profile.setId(123);
+        profile.setFirstName("Larry");
+        profile.setLastName("Cucumber");
+        profile.setEmail("larry.cucumber@example.com");
+
+        user = new CCBUser(profile);
+        date = new Date(1427889600000L); // 2015-04-01
+
+        // Setup the mocks.
+        api = EasyMock.mock(CCBAPI.class);
+        cache = EasyMock.mock(CustomFieldCache.class);
+        reporter = new CCBProgressReporter(api, cache);
+    }
+
+    private void setupCacheMocks() {
+        // Setup the Grow Level field.
+        CustomField growLevelDate = new CustomField();
+        growLevelDate.setName("udf_ind_date_1");
+        growLevelDate.setLabel(GROW_LEVEL);
+
+        CustomField growLevelPulldown = new CustomField();
+        growLevelPulldown.setName("udf_ind_pulldown_1");
+        growLevelPulldown.setLabel(GROW_LEVEL);
+
+        LookupTableItem believer = new LookupTableItem();
+        believer.setId(1);
+        believer.setOrder(2);
+        believer.setName("Believer");
+
+        EasyMock.expect(cache.getDateFieldByLabel(GROW_LEVEL))
+                .andReturn(growLevelDate).anyTimes();
+        EasyMock.expect(cache.getIndividualPulldownByLabel(GROW_LEVEL))
+                .andReturn(growLevelPulldown).anyTimes();
+        EasyMock.expect(cache.getPulldownItemByName(LookupTableType.UDF_IND_PULLDOWN_1, "Believer"))
+                .andReturn(believer).anyTimes();
+
+        // Setup the Grow Assessment field.
+        CustomField growAssessmentDate = new CustomField();
+        growAssessmentDate.setName("udf_ind_date_2");
+        growAssessmentDate.setLabel(ASSESSMENT_LEVEL);
+
+        CustomField growAssessmentPulldown = new CustomField();
+        growAssessmentPulldown.setName("udf_ind_pulldown_2");
+        growAssessmentPulldown.setLabel(ASSESSMENT_LEVEL);
+
+        EasyMock.expect(cache.getDateFieldByLabel(ASSESSMENT_LEVEL))
+                .andReturn(growAssessmentDate).anyTimes();
+        EasyMock.expect(cache.getIndividualPulldownByLabel(ASSESSMENT_LEVEL))
+                .andReturn(growAssessmentPulldown).anyTimes();
+        EasyMock.expect(cache.getPulldownItemByName(LookupTableType.UDF_IND_PULLDOWN_2, "Believer"))
+                .andReturn(believer).anyTimes();
+    }
+
+    @Test
+    public void reportAssessmentComplete() throws Exception {
+        // Setup mocks
+        setupCacheMocks();
+        Capture<UpdateIndividualProfileRequest> reqCapture = EasyMock.newCapture();
+        EasyMock.expect(api.updateIndividualProfile(EasyMock.capture(reqCapture)))
+                .andReturn(EasyMock.mock(UpdateIndividualProfileResponse.class));
+        replay();
+
+        // Test reporter
+        reporter.reportAssessmentComplete(user, "Believer", date, "Data");
+
+        // Assert that the profile was updated.
+        verify();
+        assertTrue(reqCapture.hasCaptured());
+        UpdateIndividualProfileRequest req = reqCapture.getValue();
+
+        // Both the Grow Level and Grow Assessment fields should be updated.
+        assertEquals(1, req.getCustomPulldownFields().get("udf_pulldown_1").intValue());
+        assertEquals("2015-04-01", req.getCustomDateFields().get("udf_date_1").toString());
+        assertEquals(1, req.getCustomPulldownFields().get("udf_pulldown_2").intValue());
+        assertEquals("2015-04-01", req.getCustomDateFields().get("udf_date_2").toString());
+    }
+
+    @Test
+    public void testReportChapterCompleteNoPreviousChapter() throws Exception {
+        // Setup mocks
+        setupCacheMocks();
+        Capture<UpdateIndividualProfileRequest> reqCapture = EasyMock.newCapture();
+        EasyMock.expect(api.updateIndividualProfile(EasyMock.capture(reqCapture)))
+                .andReturn(EasyMock.mock(UpdateIndividualProfileResponse.class));
+        replay();
+
+        // Test reporter
+        reporter.reportChapterComplete(user, "Believer", date);
+
+        // Assert that the profile was updated.
+        verify();
+        assertTrue(reqCapture.hasCaptured());
+        UpdateIndividualProfileRequest req = reqCapture.getValue();
+        assertEquals(1, req.getCustomPulldownFields().get("udf_pulldown_1").intValue());
+        assertEquals("2015-04-01", req.getCustomDateFields().get("udf_date_1").toString());
+    }
+
+    @Test
+    public void testReportChapterCompleteLowerPreviousChapter() throws Exception {
+        // Setup mocks
+        setupCacheMocks();
+        Capture<UpdateIndividualProfileRequest> reqCapture = EasyMock.newCapture();
+        EasyMock.expect(api.updateIndividualProfile(EasyMock.capture(reqCapture)))
+                .andReturn(EasyMock.mock(UpdateIndividualProfileResponse.class));
+
+        setUserPulldownSelection(GROW_LEVEL, "Seeker");
+
+        replay();
+
+        // Test reporter
+        reporter.reportChapterComplete(user, "Believer", date);
+
+        // Assert that the profile was updated.
+        verify();
+        assertTrue(reqCapture.hasCaptured());
+        UpdateIndividualProfileRequest req = reqCapture.getValue();
+        assertEquals(1, req.getCustomPulldownFields().get("udf_pulldown_1").intValue());
+        assertEquals("2015-04-01", req.getCustomDateFields().get("udf_date_1").toString());
+    }
+
+    @Test
+    public void testReportChapterCompleteHigherPreviousChapter() throws Exception {
+        // Setup mocks
+        setupCacheMocks();
+        setUserPulldownSelection(GROW_LEVEL, "Disciple");
+
+        replay();
+
+        // Test reporter
+        reporter.reportChapterComplete(user, "Believer", date);
+
+        // Assert that the profile was updated.
+        verify();
+    }
+
+    @Test
+    public void testReportChapterCompleteNoCustomField() throws Exception {
+        // Setup mocks
+        EasyMock.expect(cache.getDateFieldByLabel(EasyMock.anyString())).andReturn(null).anyTimes();
+        EasyMock.expect(cache.getIndividualPulldownByLabel(EasyMock.anyString())).andReturn(null).anyTimes();
+        EasyMock.expect(cache.getPulldownItemByName(EasyMock.anyObject(), EasyMock.anyString()))
+                .andReturn(null).anyTimes();
+        replay();
+
+        // Test reporter
+        reporter.reportChapterComplete(user, "Believer", date);
+
+        // Assert that the profile was updated.
+        verify();
+    }
+
+    @Test
+    public void testReportChapterCompleteNoSuchValue() throws Exception {
+        // Setup mocks
+        setupCacheMocks();
+        EasyMock.expect(cache.getPulldownItemByName(LookupTableType.UDF_IND_PULLDOWN_1, "Foo"))
+                .andReturn(null).anyTimes();
+        Capture<UpdateIndividualProfileRequest> reqCapture = EasyMock.newCapture();
+        EasyMock.expect(api.updateIndividualProfile(EasyMock.capture(reqCapture)))
+                .andReturn(EasyMock.mock(UpdateIndividualProfileResponse.class));
+        replay();
+
+        // Test reporter
+        reporter.reportChapterComplete(user, "Foo", date);
+
+        // Assert that the profile was updated.
+        verify();
+        assertTrue(reqCapture.hasCaptured());
+        UpdateIndividualProfileRequest req = reqCapture.getValue();
+        assertNull(req.getCustomPulldownFields().get("udf_pulldown_1"));
+        assertEquals("2015-04-01", req.getCustomDateFields().get("udf_date_1").toString());
+    }
+
+    private void setUserPulldownSelection(final String field, final String value) {
+        // Get the pulldown field collection for the user.
+        CustomFieldCollection<CustomPulldownFieldValue> pulldowns = user.getProfile().getCustomPulldownFields();
+        if (pulldowns == null) {
+            pulldowns = new CustomFieldCollection<>();
+            user.getProfile().setCustomPulldownFields(pulldowns);
+        }
+
+        // Create the selection for the value.
+        PulldownSelection selection = new PulldownSelection();
+        selection.setLabel(value);
+
+        // Create the field/value pair and add it to the collection.
+        CustomPulldownFieldValue fieldValue = new CustomPulldownFieldValue();
+        fieldValue.setName(field); // This is unused by the test, but it should be a udf_ identifier.
+        fieldValue.setLabel(field);
+        fieldValue.setSelection(selection);
+        pulldowns.add(fieldValue);
+    }
+
+    private void replay() {
+        EasyMock.replay(api, cache);
+    }
+
+    private void verify() {
+        EasyMock.verify(api, cache);
+    }
+}
\ No newline at end of file