GSoC 2024: Add Survey Feature

[amrhossamdev]

Related to #1173

Project

Name : Amr Hossam
Project : Build Surveys into OneBusAway
Current State: Testing phase

Introduction

During my participation in the Google Summer of Code 2024 program, I had the opportunity to develop a critical feature for the OneBusAway (OBA) Android app aimed at addressing a significant gap in transit service feedback.

Transit agencies often struggle to obtain direct feedback from riders, which impedes their ability to improve service quality and accessibility. This challenge is particularly acute for women, who encounter unique issues such as safety concerns and complex care-related travel patterns that are not always adequately addressed.

To bridge this gap, my project introduced a travel survey feature within the OBA app. This feature allows riders to provide direct feedback on their transit experiences, with a special focus on understanding and enhancing the transit experiences of women.

Screenshots

The project involved:

• Designing and Developing the Survey UI/UX: Creating an intuitive and accessible user interface for the survey feature to ensure a seamless and engaging user experience.
• Integrating Survey UI with Backend APIs: Connecting the survey interface to backend APIs to enable data retrieval and submission of survey responses.
• Utilize RoomDB for Managing Study and Survey States: Employ RoomDB to effectively manage and store the states of studies and surveys for each user.

Features:

• Display Survey UI on Map: Enable the survey interface to be shown directly on the map within the app.
• Target Surveys to Specific Stops/Routes: Configure the survey UI to appear for specific transit stops or routes.
• Support External Surveys: Integrate functionality to display surveys from other platforms, such as Google Forms.
• Manage Survey Preferences: Provide users with the option to enable or disable the receipt of surveys.
• Upcoming Features: Implement functionalities for managing surveys, including subscribing to or unsubscribing from specific studies.

Related PRs:

• feat: Integrate Recent Stops Data into External Surveys #1234
• Add Stop ID to Survey Submission Request Body #1239

Left to do:

• Complete manage study (waiting for backend services to be completed)
• Release beta channel version & testing

TODO

• Apply the AndroidStyle.xml style template to your code in Android Studio.

• Run the unit tests with gradlew connectedObaGoogleDebugAndroidTest to make sure you didn't break anything

• If you have multiple commits please combine them into one commit by squashing them for the initial submission of the pull request. When addressing comments on a pull request, please push a new commit per comment when possible (reviewers will squash and merge using GitHub merge tool)

[aaronbrethorst]

Please go back and add doc comments to all of these classes to explain what they are. Doesn't have to be a lot of detail—just 1-2 sentences per class for all of the new classes you've added.

[amrhossamdev]

Done

[aaronbrethorst]

Great work! I think there are undoubtedly some areas where we'll have to do some small rework tasks, but I don't think that should prevent merging this in. Let's get this into the beta channel!