GSoC 2024: Add Survey Feature

build.gradle

@@ -17,7 +17,7 @@
 // Top-level build file where you can add configuration options common to all sub-projects/modules.
 
 buildscript {
-    ext.kotlin_version = '1.6.21'
+    ext.kotlin_version = '1.9.21'
     repositories {
         google()
         mavenCentral()

onebusaway-android/build.gradle

@@ -19,7 +19,7 @@ import org.apache.tools.ant.filters.ConcatFilter
 
 apply plugin: 'com.android.application'
 apply plugin: 'kotlin-android'
-apply plugin: 'kotlin-android-extensions'
+apply plugin: 'kotlin-kapt'
 
 repositories {
     maven {
@@ -275,10 +275,12 @@ android {
     }
 
     compileOptions {
-        sourceCompatibility JavaVersion.VERSION_1_8
-        targetCompatibility JavaVersion.VERSION_1_8
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
+    }
+    kotlinOptions {
+        jvmTarget = "1.8"
     }
-
     testOptions {
         unitTests.includeAndroidResources true
     }
@@ -368,6 +370,10 @@ dependencies {
     implementation "androidx.concurrent:concurrent-listenablefuture-callback:1.0.0-beta01"
     implementation "androidx.core:core-ktx:1.7.0"
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
+    // RoomDB
+    implementation "androidx.room:room-runtime:2.6.1"
+    kapt "androidx.room:room-compiler:2.6.1"
+    implementation "androidx.room:room-ktx:2.6.1"
 
 }
 

onebusaway-android/src/main/AndroidManifest.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- Copyright (C) 2011-2022 Paul Watts ([email protected]),
-     University of South Florida ([email protected]), 
+     University of South Florida ([email protected]),
      Microsoft Corporation.
 
      Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,10 +19,10 @@
     xmlns:android="http://schemas.android.com/apk/res/android">
 
     <permission
-            android:name="${applicationId}.permission.TRIP_SERVICE"
-            android:label="@string/trip_service_perm_label"
-            android:description="@string/trip_service_perm_description"
-            android:protectionLevel="normal"/>
+        android:name="${applicationId}.permission.TRIP_SERVICE"
+        android:label="@string/trip_service_perm_label"
+        android:description="@string/trip_service_perm_description"
+        android:protectionLevel="normal"/>
 
     <uses-permission android:name="android.permission.INTERNET"/>
     <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
@@ -64,13 +64,18 @@
             android:value="org.onebusaway.android.ui.SearchActivity" />
 
         <activity
-                android:name=".ui.DonationLearnMoreActivity"
-                android:exported="false"
-                android:label="@string/title_activity_donation_learn_more"
-                android:parentActivityName=".ui.HomeActivity">
+            android:theme="@style/Theme.OneBusAway.NoActionBar"
+            android:name=".ui.survey.activities.SurveyWebViewActivity"
+            android:exported="false" />
+
+        <activity
+            android:name=".ui.DonationLearnMoreActivity"
+            android:exported="false"
+            android:label="@string/title_activity_donation_learn_more"
+            android:parentActivityName=".ui.HomeActivity">
             <meta-data
-                    android:name="android.support.PARENT_ACTIVITY"
-                    android:value="org.onebusaway.android.ui.PreferencesActivity" />
+                android:name="android.support.PARENT_ACTIVITY"
+                android:value="org.onebusaway.android.ui.PreferencesActivity" />
         </activity>
 
         <activity
@@ -82,8 +87,8 @@
                 <action android:name="android.intent.action.SEARCH" />
             </intent-filter>
             <meta-data
-                    android:name="android.app.searchable"
-                    android:resource="@xml/searchable"/>
+                android:name="android.app.searchable"
+                android:resource="@xml/searchable"/>
         </activity>
 
         <activity
@@ -230,8 +235,8 @@
                     android:scheme="onebusaway" />
             </intent-filter>
             <meta-data
-                    android:name="android.support.PARENT_ACTIVITY"
-                    android:value="org.onebusaway.android.ui.HomeActivity"/>
+                android:name="android.support.PARENT_ACTIVITY"
+                android:value="org.onebusaway.android.ui.HomeActivity"/>
         </activity>
         <activity android:name="org.onebusaway.android.ui.RegionsActivity"/>
         <activity android:name="org.onebusaway.android.ui.AgenciesActivity"/>
@@ -251,8 +256,8 @@
             </intent-filter>
             <!-- Parent activity meta-data to support 4.0 and lower -->
             <meta-data
-                    android:name="android.support.PARENT_ACTIVITY"
-                    android:value="org.onebusaway.android.ui.HomeActivity"/>
+                android:name="android.support.PARENT_ACTIVITY"
+                android:value="org.onebusaway.android.ui.HomeActivity"/>
         </activity>
         <activity
             android:name="org.onebusaway.android.ui.NightLightActivity"
@@ -267,16 +272,16 @@
             </intent-filter>
             <!-- Parent activity meta-data to support 4.0 and lower -->
             <meta-data
-                    android:name="android.support.PARENT_ACTIVITY"
-                    android:value="org.onebusaway.android.ui.HomeActivity"/>
+                android:name="android.support.PARENT_ACTIVITY"
+                android:value="org.onebusaway.android.ui.HomeActivity"/>
         </activity>
         <activity
             android:name="org.onebusaway.android.ui.TripPlanActivity"
             android:label="@string/title_activity_trip_plan"
             android:parentActivityName="org.onebusaway.android.ui.HomeActivity">
             <meta-data
-                    android:name="android.support.PARENT_ACTIVITY"
-                    android:value="org.onebusaway.android.ui.HomeActivity"/>
+                android:name="android.support.PARENT_ACTIVITY"
+                android:value="org.onebusaway.android.ui.HomeActivity"/>
         </activity>
         <activity
             android:name="org.onebusaway.android.ui.FeedbackActivity"
@@ -291,8 +296,8 @@
 
         <!-- Provider is defined in build.gradle flavors -->
         <provider
-                android:name="org.onebusaway.android.provider.ObaProvider"
-                android:authorities="${databaseAuthority}"/>
+            android:name="org.onebusaway.android.provider.ObaProvider"
+            android:authorities="${databaseAuthority}"/>
 
         <service
             android:name=".tripservice.TripService"
@@ -362,38 +367,38 @@
         </receiver>
 
         <receiver
-                android:enabled="true" android:name=".travelbehavior.receiver.TransitionBroadcastReceiver">
+            android:enabled="true" android:name=".travelbehavior.receiver.TransitionBroadcastReceiver">
         </receiver>
         <receiver
-                android:enabled="true" android:name=".travelbehavior.receiver.RecognitionBroadcastReceiver">
+            android:enabled="true" android:name=".travelbehavior.receiver.RecognitionBroadcastReceiver">
         </receiver>
         <receiver
-                android:enabled="true" android:name=".travelbehavior.receiver.LocationBroadcastReceiver">
+            android:enabled="true" android:name=".travelbehavior.receiver.LocationBroadcastReceiver">
         </receiver>
 
         <meta-data
-                android:name="com.google.android.gms.version"
-                android:value="@integer/google_play_services_version"/>
+            android:name="com.google.android.gms.version"
+            android:value="@integer/google_play_services_version"/>
 
         <meta-data
-                android:name="com.google.android.geo.API_KEY"
-                android:value="@string/apiv2_key"/>
+            android:name="com.google.android.geo.API_KEY"
+            android:value="@string/apiv2_key"/>
 
         <activity
-                android:name="org.onebusaway.android.ui.AboutActivity"
-                android:label="@string/title_activity_about"
-                android:parentActivityName="org.onebusaway.android.ui.PreferencesActivity"
-                android:theme="@style/Theme.OneBusAway.NoActionBar">
+            android:name="org.onebusaway.android.ui.AboutActivity"
+            android:label="@string/title_activity_about"
+            android:parentActivityName="org.onebusaway.android.ui.PreferencesActivity"
+            android:theme="@style/Theme.OneBusAway.NoActionBar">
             <meta-data
-                    android:name="android.support.PARENT_ACTIVITY"
-                    android:value="org.onebusaway.android.ui.PreferencesActivity"/>
+                android:name="android.support.PARENT_ACTIVITY"
+                android:value="org.onebusaway.android.ui.PreferencesActivity"/>
         </activity>
 
         <!-- Opt-out of June 2018 Android Maps styling with pin POI icons - see #891 -->
         <meta-data android:name="com.google.android.gms.maps.API_OPTIONS" android:value="B3H9HE845CFHYG"/>
     </application>
 
     <uses-feature
-            android:glEsVersion="0x00020000"
-            android:required="true"/>
-</manifest>
+        android:glEsVersion="0x00020000"
+        android:required="true"/>
+</manifest>

onebusaway-android/src/main/java/org/onebusaway/android/database/AppDatabase.kt

@@ -0,0 +1,19 @@
+package org.onebusaway.android.database
+
+import androidx.room.Database
+import androidx.room.RoomDatabase
+import org.onebusaway.android.ui.survey.dao.StudiesDao
+import org.onebusaway.android.ui.survey.dao.SurveysDao
+import org.onebusaway.android.ui.survey.entity.Study
+import org.onebusaway.android.ui.survey.entity.Survey
+
+/**
+ * Main database class for the app, containing `Study` and `Survey` entities.
+ * Provides abstract methods for accessing `StudiesDao` and `SurveysDao`.
+ * The `@Database` annotation sets up Room with version 1 of the schema.
+ */
+@Database(entities = [Study::class, Survey::class], version = 1)
+abstract class AppDatabase : RoomDatabase() {
+    abstract fun studiesDao(): StudiesDao
+    abstract fun surveysDao(): SurveysDao
+}

onebusaway-android/src/main/java/org/onebusaway/android/io/request/survey/ObaStudyRequest.java

@@ -0,0 +1,55 @@
+package org.onebusaway.android.io.request.survey;
+
+import android.content.Context;
+import android.net.Uri;
+
+import androidx.annotation.NonNull;
+
+import org.onebusaway.android.R;
+import org.onebusaway.android.app.Application;
+import org.onebusaway.android.io.request.RequestBase;
+import org.onebusaway.android.io.request.survey.model.StudyResponse;
+import org.onebusaway.android.ui.survey.SurveyPreferences;
+
+import java.util.concurrent.Callable;
+
+/**
+ * Represents a request to fetch study data.
+ */
+
+public final class ObaStudyRequest extends RequestBase implements Callable<StudyResponse> {
+
+    private ObaStudyRequest(Uri uri) {
+        super(uri);
+    }
+
+    public static class Builder {
+
+        private static Uri URI = null;
+
+        public Builder(Context context) {
+            String studyAPIURL = Application.get().getResources().getString(R.string.studies_api_url);
+            studyAPIURL = studyAPIURL.replace("regionID", String.valueOf(Application.get().getCurrentRegion().getId()));
+            URI = Uri.parse(studyAPIURL).buildUpon().appendQueryParameter("user_id", SurveyPreferences.getUserUUID(context)).build();
+        }
+
+        public ObaStudyRequest build() {
+            return new ObaStudyRequest(URI);
+        }
+    }
+
+    public static ObaStudyRequest newRequest(Context context) {
+        return new Builder(context).build();
+    }
+
+    @Override
+    public StudyResponse call() {
+        return call(StudyResponse.class);
+    }
+
+    @NonNull
+    @Override
+    public String toString() {
+        return "ObaSurveyRequest [mUri=" + mUri + "]";
+    }
+}

onebusaway-android/src/main/java/org/onebusaway/android/io/request/survey/StudyRequestListener.java

@@ -0,0 +1,14 @@
+package org.onebusaway.android.io.request.survey;
+
+import org.onebusaway.android.io.request.survey.model.StudyResponse;
+
+/**
+ * Interface to handle the callbacks for survey-related requests.
+ * Implementations of this interface should define how to handle
+ * successful and failed survey responses.
+ */
+
+public interface StudyRequestListener {
+    void onSurveyResponseReceived(StudyResponse response);
+    void onSurveyResponseFail();
+}

onebusaway-android/src/main/java/org/onebusaway/android/io/request/survey/StudyRequestTask.java

@@ -0,0 +1,37 @@
+package org.onebusaway.android.io.request.survey;
+
+import android.os.AsyncTask;
+import android.util.Log;
+
+import org.onebusaway.android.io.request.survey.model.StudyResponse;
+
+/**
+ * AsyncTask for performing background operations related to study requests.
+ */
+public class StudyRequestTask extends AsyncTask<ObaStudyRequest, Void, StudyResponse> {
+    private static final String TAG = "Survey Request";
+    private StudyRequestListener mListener;
+
+    public StudyRequestTask(StudyRequestListener listener) {
+        mListener = listener;
+    }
+
+    @Override
+    protected StudyResponse doInBackground(ObaStudyRequest... requests) {
+        try {
+            return requests[0].call();
+        } catch (Exception e) {
+            Log.e(TAG, "Error executing survey request", e);
+            return null;
+        }
+    }
+
+    @Override
+    protected void onPostExecute(StudyResponse response) {
+        if (response != null) {
+            mListener.onSurveyResponseReceived(response);
+        } else {
+            mListener.onSurveyResponseFail();
+        }
+    }
+}

onebusaway-android/src/main/java/org/onebusaway/android/io/request/survey/SurveyListener.java

@@ -0,0 +1,10 @@
+package org.onebusaway.android.io.request.survey;
+
+import org.onebusaway.android.io.request.survey.submit.SubmitSurveyRequestListener;
+import org.onebusaway.android.ui.survey.SurveyActionsListener;
+
+/**
+ * Interface that combines various survey-related listeners.
+ */
+public interface SurveyListener extends StudyRequestListener, SubmitSurveyRequestListener, SurveyActionsListener {
+}