-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #280 from ibi-group/trip-survey-forward-url
Trip survey forward URL
- Loading branch information
Showing
7 changed files
with
967 additions
and
630 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
125 changes: 125 additions & 0 deletions
125
src/main/java/org/opentripplanner/middleware/controllers/api/TripSurveyController.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| package org.opentripplanner.middleware.controllers.api; | ||
|
|
||
| import io.github.manusant.ss.SparkSwagger; | ||
| import io.github.manusant.ss.rest.Endpoint; | ||
| import org.eclipse.jetty.http.HttpStatus; | ||
| import org.opentripplanner.middleware.models.MonitoredTrip; | ||
| import org.opentripplanner.middleware.models.OtpUser; | ||
| import org.opentripplanner.middleware.models.TripSurveyNotification; | ||
| import org.opentripplanner.middleware.persistence.Persistence; | ||
| import org.opentripplanner.middleware.utils.HttpUtils; | ||
| import org.opentripplanner.middleware.utils.JsonUtils; | ||
| import spark.Request; | ||
| import spark.Response; | ||
|
|
||
| import java.time.Instant; | ||
| import java.util.Date; | ||
| import java.util.Optional; | ||
|
|
||
| import static io.github.manusant.ss.descriptor.EndpointDescriptor.endpointPath; | ||
| import static io.github.manusant.ss.descriptor.MethodDescriptor.path; | ||
| import static org.opentripplanner.middleware.utils.JsonUtils.logMessageAndHalt; | ||
| import static org.opentripplanner.middleware.utils.NotificationUtils.TRIP_SURVEY_ID; | ||
| import static org.opentripplanner.middleware.utils.NotificationUtils.TRIP_SURVEY_SUBDOMAIN; | ||
|
|
||
| public class TripSurveyController implements Endpoint { | ||
| private final String ROOT_ROUTE; | ||
|
|
||
| private static final String OPEN_PATH = "/open"; | ||
|
|
||
| public TripSurveyController(String apiPrefix) { | ||
| this.ROOT_ROUTE = apiPrefix + "trip-survey"; | ||
| } | ||
|
|
||
| /** | ||
| * Register the API endpoint and GET resource that redirects to a survey form. | ||
| */ | ||
| @Override | ||
| public void bind(final SparkSwagger restApi) { | ||
| restApi.endpoint( | ||
| endpointPath(ROOT_ROUTE).withDescription("Interface for tracking opened trip surveys following a trip survey notification."), | ||
| HttpUtils.NO_FILTER | ||
| ) | ||
| .get( | ||
| path(ROOT_ROUTE + OPEN_PATH) | ||
| .withDescription("Generates a tracking survey link for a specified user, trip, notification ids.") | ||
| .withQueryParam().withName("user_id").withRequired(true).withDescription("The id of the OtpUser that this notification applies to.").and() | ||
| .withQueryParam().withName("trip_id").withRequired(true).withDescription("The id of the MonitoredTrip that this notification applies to.").and() | ||
| .withQueryParam().withName("notification_id").withRequired(true).withDescription("The id of the notification that this notification applies to.").and(), | ||
| TripSurveyController::processCall, JsonUtils::toJson | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Check that the requested survey is valid (user, trip, and notifications point to existing data). | ||
| */ | ||
| private static OtpUser checkParameters(String userId, String tripId, String notificationId, Request request) { | ||
| OtpUser user = Persistence.otpUsers.getById(userId); | ||
| if (user == null) { | ||
| returnInvalidUrlParametersError(request); | ||
| } else { | ||
| Optional<TripSurveyNotification> notificationOpt = user.findNotification(notificationId); | ||
| if (notificationOpt.isEmpty()) returnInvalidUrlParametersError(request); | ||
|
|
||
| MonitoredTrip trip = Persistence.monitoredTrips.getById(tripId); | ||
| if (trip == null) returnInvalidUrlParametersError(request); | ||
| } | ||
|
|
||
| return user; | ||
| } | ||
|
|
||
| private static void returnInvalidUrlParametersError(Request request) { | ||
| logMessageAndHalt(request, HttpStatus.BAD_REQUEST_400, "Invalid URL parameters"); | ||
| } | ||
|
|
||
| /** | ||
| * Mark notification as opened, but if an opened date is already populated, do nothing. | ||
| */ | ||
| private static void updateNotificationStateIfNeeded(OtpUser user, String notificationId) { | ||
| TripSurveyNotification notification = user.findNotification(notificationId).orElse(null); | ||
| if (notification != null && notification.timeOpened == null) { | ||
| notification.timeOpened = Date.from(Instant.now()); | ||
| Persistence.otpUsers.replace(user.id, user); | ||
| } | ||
| } | ||
|
|
||
| public static String makeTripSurveyUrl(String subdomain, String surveyId, String userId, String tripId, String notificationId) { | ||
| // Parameters have been checked before, so there shouldn't be a need to encode parameters. | ||
| return String.format( | ||
| "https://%s.typeform.com/to/%s#user_id=%s&trip_id=%s¬ification_id=%s", | ||
| subdomain, | ||
| surveyId, | ||
| userId, | ||
| tripId, | ||
| notificationId | ||
| ); | ||
| } | ||
|
|
||
| private static boolean processCall(Request req, Response res) { | ||
| String userId = req.queryParams("user_id"); | ||
| String tripId = req.queryParams("trip_id"); | ||
| String notificationId = req.queryParams("notification_id"); | ||
|
|
||
| OtpUser user = checkParameters(userId, tripId, notificationId, req); | ||
|
|
||
| if (user != null) { | ||
| String surveyUrl = makeTripSurveyUrl( | ||
| TRIP_SURVEY_SUBDOMAIN, | ||
| TRIP_SURVEY_ID, | ||
| userId, | ||
| tripId, | ||
| notificationId | ||
| ); | ||
|
|
||
| // Update notification state | ||
| updateNotificationStateIfNeeded(user, notificationId); | ||
|
|
||
| // Redirect | ||
| res.redirect(surveyUrl); | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.