OTP-888 Refactor mobilityProfile into its own object

src/main/java/org/opentripplanner/middleware/controllers/api/OtpUserController.java

@@ -7,6 +7,7 @@
 import org.eclipse.jetty.http.HttpStatus;
 import org.opentripplanner.middleware.auth.Auth0Connection;
 import org.opentripplanner.middleware.auth.RequestingUser;
+import org.opentripplanner.middleware.models.MobilityProfile;
 import org.opentripplanner.middleware.models.OtpUser;
 import org.opentripplanner.middleware.persistence.Persistence;
 import org.opentripplanner.middleware.utils.JsonUtils;
@@ -16,9 +17,7 @@
 import spark.Request;
 import spark.Response;
 
-import java.util.Collections;
 import java.util.Date;
-import java.util.Set;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
@@ -39,8 +38,6 @@ public class OtpUserController extends AbstractUserController<OtpUser> {
     private static final String VERIFY_ROUTE_TEMPLATE = "/:%s/%s/:%s";
     /** Regex to check E.164 phone number format per https://www.twilio.com/docs/glossary/what-e164 */
     private static final Pattern PHONE_E164_PATTERN = Pattern.compile("^\\+[1-9]\\d{1,14}$");
-    /** Mobility devices used to calculate mobility mode. Keywords are taken from Georgia Tech document. */
-    private static final Set<String> MOBILITY_DEVICES = Set.of("Device", "MScooter", "WChairE", "WChairM", "Some");
 
     public OtpUserController(String apiPrefix) {
         super(apiPrefix, Persistence.otpUsers, OTP_USER_PATH);
@@ -55,13 +52,13 @@ OtpUser preCreateHook(OtpUser user, Request req) {
             Auth0Connection.ensureApiUserHasApiKey(req);
             user.applicationId = requestingUser.apiUser.id;
         }
-        user.mobilityMode = calculateMobilityMode(user);
+        MobilityProfile.updateMobilityMode(user.mobilityProfile);
         return super.preCreateHook(user, req);
     }
 
     @Override
     OtpUser preUpdateHook(OtpUser user, OtpUser preExistingUser, Request req) {
-        user.mobilityMode = calculateMobilityMode(user);
+        MobilityProfile.updateMobilityMode(user.mobilityProfile);
         return super.preUpdateHook(user, preExistingUser, req);
     }
 
@@ -181,68 +178,4 @@ public static boolean isPhoneNumberValidE164(String phoneNumber) {
         Matcher m = PHONE_E164_PATTERN.matcher(phoneNumber);
         return m.matches();
     }
-
-    /**
-     * Calculate and return the "mobility mode", a keyword or compound keyword specified by Georgia Tech,
-     * based on a number {@code OtpUser} fields related to mobility.
-     * @param user with fields that are consulted to calculate mobility mode
-     * @return mobility mode as a single string
-     */
-    private static String calculateMobilityMode(OtpUser user) {
-        // Variable names and the strings we parse are from Georgia Tech document, to facilitate syncing changes.
-        // The testing for devices and vision in this order are from the same document; note that this means the
-        // devices tested for later will override the earlier "Temp"orary settings.
-        String mModeTemp = "None";
-        String visionTemp = "None";
-
-        if (user.mobilityDevices == null) {
-            user.mobilityDevices = Collections.EMPTY_LIST;
-	}
-        if (user.mobilityDevices.isEmpty() || user.mobilityDevices.contains("none")) {
-            user.mobilityDevices.clear();
-	} else {
-            if (user.mobilityDevices.contains("white cane")) {
-                visionTemp = "Blind";
-            }
-            if (user.mobilityDevices.contains("manual walker")
-                    || user.mobilityDevices.contains("wheeled walker")
-                    || user.mobilityDevices.contains("cane")
-                    || user.mobilityDevices.contains("crutches")
-                    || user.mobilityDevices.contains("stroller")
-                    || user.mobilityDevices.contains("service animal")) {
-                mModeTemp = "Device";
-            }
-            if (user.mobilityDevices.contains("mobility scooter")) {
-                mModeTemp = "MScooter";
-            }
-            if (user.mobilityDevices.contains("electric wheelchair")) {
-                mModeTemp = "WChairE";
-            }
-            if (user.mobilityDevices.contains("manual wheelchair")) {
-                mModeTemp = "WChairM";
-            }
-
-            if ("None".equals(mModeTemp) && user.isMobilityLimited) {
-                mModeTemp = "Some";
-            }
-        }
-
-        if (visionTemp.isEmpty() && "low-vision".equals(user.visionLimitation)) {
-            visionTemp = "LowVision";
-        } else if (visionTemp.isEmpty() && "legally blind".equals(user.visionLimitation)) {
-            visionTemp = "Blind";
-        }
-
-        // Create combinations for mobility mode and vision
-        if (Set.of("LowVision", "Blind").contains(visionTemp)) {
-            if ("None".equals(mModeTemp)) {
-                return visionTemp;
-            } else if (MOBILITY_DEVICES.contains(mModeTemp)) {
-                return mModeTemp + "-" + visionTemp;
-	    }
-        } else if (MOBILITY_DEVICES.contains(mModeTemp)) {
-            return mModeTemp;
-        }
-        return "None";
-    }
 }

src/main/java/org/opentripplanner/middleware/models/MobilityProfile.java

@@ -0,0 +1,116 @@
+package org.opentripplanner.middleware.models;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.io.Serializable;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Set;
+
+/**
+ * Mobility profile data, to keeps track of values from UI or mobile app and
+ * uses them to maintain a "mobility mode," which are keywords specified in
+ * the Georgia Tech Mobility Profile Configuration / Logical Flow document.
+ * <p>
+ * Provided as part of {@link OtpUser}, example JSON format:
+ * <code>
+ *   ...
+ *   "mobilityProfile": {
+ *     "isMobilityLimited": true,
+ *     "mobilityDevices": ["service animal", "electric wheelchair"],
+ *     "visionLimitation": "low-vision",
+ *     "mobilityMode": "WChairE-LowVision",
+ *   }
+ *   ...
+ * </code>
+ */
+public class MobilityProfile implements Serializable {
+    // Selected mobility mode keywords from Georgia Tech document.
+    private static final Set<String> MOBILITY_DEVICES = Set.of("Device", "MScooter", "WChairE", "WChairM", "Some");
+
+    public enum VisionLimitation {
+        @JsonProperty("legally-blind") LEGALLY_BLIND,
+        @JsonProperty("low-vision") LOW_VISION,
+        @JsonProperty("none") NONE
+    }
+
+    /** Whether the user indicates that their mobility is limited (slower). */
+    public boolean isMobilityLimited;
+
+    /** User may indicate zero or more mobility devices. */
+    public Collection<String> mobilityDevices = Collections.EMPTY_LIST;
+
+    /** Compound keyword that controller calculates from mobility and vision values. */
+    @JsonIgnore
+    public String mobilityMode;
+
+    /** User may indicate levels of vision limitation. */
+    public VisionLimitation visionLimitation = VisionLimitation.NONE;
+
+
+    /**
+     * Construct the mobility mode keyword or compound keyword from fields in
+     * a mobility profile, and update the mobility profile with it.  Follows
+     * the Georgia Tech Mobility Profile Configuration / Logical Flow document,
+     * so that the mode is constructed based on specific strings in a specific
+     * order.  The device strings are expected to change on occasion.
+     * @param mobilityProfile consulted to construct and update mobility mode
+     */
+    public static void updateMobilityMode(MobilityProfile mobilityProfile) {
+        // Variable names and the strings we parse are from Georgia Tech document, to facilitate syncing
+        // changes.  The testing for devices and vision in this order are from the same document; note
+        // that this means the devices tested for later will override the earlier "Temp"orary settings.
+        String mModeTemp = "None";
+        String visionTemp = "None";
+
+        // If "none" has been specified at all, we just wipe the mobility devices clear,
+        // else we look at the mobility devices and settle on the one that is the most involved.
+        if (mobilityProfile.mobilityDevices.contains("none")) {
+            mobilityProfile.mobilityDevices.clear();
+        } else {
+            if (mobilityProfile.mobilityDevices.contains("white cane")) {
+                visionTemp = "Blind";
+            }
+            if (mobilityProfile.mobilityDevices.contains("manual walker")
+                    || mobilityProfile.mobilityDevices.contains("wheeled walker")
+                    || mobilityProfile.mobilityDevices.contains("cane")
+                    || mobilityProfile.mobilityDevices.contains("crutches")
+                    || mobilityProfile.mobilityDevices.contains("stroller")
+                    || mobilityProfile.mobilityDevices.contains("service animal")) {
+                mModeTemp = "Device";
+            }
+            if (mobilityProfile.mobilityDevices.contains("mobility scooter")) {
+                mModeTemp = "MScooter";
+            }
+            if (mobilityProfile.mobilityDevices.contains("electric wheelchair")) {
+                mModeTemp = "WChairE";
+            }
+            if (mobilityProfile.mobilityDevices.contains("manual wheelchair")) {
+                mModeTemp = "WChairM";
+            }
+
+            if ("None".equals(mModeTemp) && mobilityProfile.isMobilityLimited) {
+                mModeTemp = "Some";
+            }
+        }
+
+        if (MobilityProfile.VisionLimitation.LOW_VISION == mobilityProfile.visionLimitation) {
+            visionTemp = "LowVision";
+        } else if (MobilityProfile.VisionLimitation.LEGALLY_BLIND == mobilityProfile.visionLimitation) {
+            visionTemp = "Blind";
+        }
+
+        // Create combinations for mobility mode and vision
+        if (Set.of("LowVision", "Blind").contains(visionTemp)) {
+            if ("None".equals(mModeTemp)) {
+                mobilityProfile.mobilityMode = visionTemp;
+            } else if (MOBILITY_DEVICES.contains(mModeTemp)) {
+                mobilityProfile.mobilityMode = mModeTemp + "-" + visionTemp;
+            }
+        } else if (MOBILITY_DEVICES.contains(mModeTemp)) {
+            mobilityProfile.mobilityMode = mModeTemp;
+        }
+        mobilityProfile.mobilityMode = "None";
+    }
+}

src/main/java/org/opentripplanner/middleware/models/OtpUser.java

@@ -33,21 +33,11 @@ public enum Notification {
     /** Whether the user has consented to terms of use. */
     public boolean hasConsentedToTerms;
 
-    /** Whether the user has indicated that their mobility is limited (slower). */
-    public boolean isMobilityLimited;
-
     /** Whether the phone number has been verified. */
     public boolean isPhoneNumberVerified;
 
-    /** User may have indicated zero or more mobility devices. */
-    public Collection<String> mobilityDevices;
-
-    /** Compound keyword that controller calculates from mobility and vision values. */
-    @JsonIgnore
-    public String mobilityMode;
-
-    /** One of "low-vision" "legally blind" "none" */
-    public String visionLimitation;
+    /** Mobility profile. */
+    public MobilityProfile mobilityProfile;
 
     /**
      * Notification preferences for this user

src/main/resources/latest-spark-swagger-output.yaml

@@ -2550,18 +2550,10 @@ definitions:
         type: "boolean"
       hasConsentedToTerms:
         type: "boolean"
-      isMobilityLimited:
-        type: "boolean"
       isPhoneNumberVerified:
         type: "boolean"
-      mobilityDevices:
-        type: "array"
-        items:
-          type: "string"
-      mobilityMode:
-        type: "string"
-      visionLimitation:
-        type: "string"
+      mobilityProfile:
+        $ref: "#/definitions/MobilityProfile"
       notificationChannel:
         type: "array"
         items:
@@ -2588,6 +2580,23 @@ definitions:
         type: "boolean"
       applicationId:
         type: "string"
+  MobilityProfile:
+    type: "object"
+    properties:
+      isMobilityLimited:
+        type: "boolean"
+      mobilityDevices:
+        type: "array"
+        items:
+          type: "string"
+      mobilityMode:
+        type: "string"
+      visionLimitation:
+        type: "string"
+        enum:
+        - "LEGALLY_BLIND"
+        - "LOW_VISION"
+        - "NONE"
   GetUsageResult:
     type: "object"
     properties: