v1.3.0 Release Candidate

.github/workflows/GenerateBuildArtifact.yml

@@ -2,7 +2,7 @@ name: Generate Build Artifact
 
 on:
   pull_request:
-    branches: ["main", "release"]
+    branches: ["release"]
 
 jobs:
   build:
@@ -37,10 +37,10 @@ jobs:
         run: ./gradlew clean
 
       - name: Build with Gradle
-        run: ./gradlew
+        run: ./gradlew build
 
-      - name: Generate and upload a Build Artifact
-        uses: actions/upload-artifact@v3.1.3
-        with:
-          name: KNUTICE_RC.apk
-          path: app/build/outputs/apk/debug/app-debug.apk
+#      - name: Generate and upload a Build Artifact
+#        uses: actions/upload-artifact@v3.1.3
+#        with:
+#          name: KNUTICE_RC.apk
+#          path: app/build/outputs/apk/debug/app-debug.apk

README.md

@@ -1,6 +1,9 @@
-<img src="https://github.com/user-attachments/assets/f1bc12e8-f218-4d58-a7bf-5e8d4c24327b" width="100">
+![Banner](https://github.com/user-attachments/assets/67608836-b085-4d6b-9f6f-faa562e20912)
+[<img width="380px;" src="https://github.com/user-attachments/assets/e49643e6-3e2b-4a33-97fb-d2f94a8ea91e"/>](https://play.google.com/store/apps/details?id=com.doyoonkim.knutice)
+
 <br>
 
+
 # 🔔 KNUTICE
 - 국립한국교통대학교 공지사항 알리미
 
@@ -29,22 +32,23 @@
 <br>
 
 # 📱 Preview
-<div style="display: flex; justify-content: center; margin-bottom: 10px;">
-
-<img width="190" alt="스크린샷 2024-08-15 23 51 59" src="https://github.com/user-attachments/assets/5f6568fc-b839-4704-96d7-f893d18600c6">
-
-<img width="190" alt="스크린샷 2024-08-15 23 52 56" src="https://github.com/user-attachments/assets/070ee2c6-420f-416a-9395-4837b4c5c009">
-
-<img width="190" alt="스크린샷 2024-08-15 23 53 12" src="https://github.com/user-attachments/assets/40e37308-ac29-4b69-b065-2184591f7375">
-
+<div style="display: flex; overflow-x: auto; justify-content: center; margin-bottom: 10px;">
+  <img width="180" alt="스크린샷 2024-08-15 23 51 59" src="https://github.com/user-attachments/assets/5ba32b68-0103-4609-83e0-20cc1a4d58f3">
+  <img width="180" alt="스크린샷 2024-08-15 23 51 59" src="https://github.com/user-attachments/assets/3b8021c6-74f5-40a4-a1e7-447f2773a62f">
+  <img width="180" alt="스크린샷 2024-08-15 23 51 59" src="https://github.com/user-attachments/assets/e800a5eb-7ea8-4431-ad3e-0cdfd74c8b3f">
+  <img width="180" alt="스크린샷 2024-08-15 23 51 59" src="https://github.com/user-attachments/assets/64a89caa-8ed2-41a4-9128-18870bc93e90">
+  <img width="180" alt="스크린샷 2024-08-15 23 51 59" src="https://github.com/user-attachments/assets/d9cb1e37-67b1-484a-bf29-ae446f79a469">
+  <img width="180" alt="스크린샷 2024-08-15 23 51 59" src="https://github.com/user-attachments/assets/faa05f29-d41d-4def-b483-ed0655f1c116">
 </div>
 
 <br>
 
 # 🧐 What I learned
 - Jetpack Compose를 이용하여 UI 설계/구현하는 방법, Jetpack Compose로 구현한 UI의 생명주기 관리등과 더불어 실제 클라이언트에 Jetpack Compose를 효율적으로 접목시키는 방법에 대해 알게 되었어요.
 - Kotlin Flow를 활용하여 MVVM 아키텍쳐를 준수하며 각 레이어를 이어주는 데이터 파이프라인 구축에 대 자세히 알게 되었어요.
+  > snapshotFlow를 통하여 지속되는 데이터 입력을 요구 조건에 맞게 처리하는 방법에 대해 알게 되었어요.
 - Dagger Hilt를 사용한 의존성 주입을 실제 클라이언트에 적용해 보면서 의존성 주입 기법이 가진 장점들을 몸소 경험할 수 있었어요.
 - Kotlin Coroutine을 활용하여 기기에 부담이 되는 작업(외부 저장소에서 데이터 획득 등)을 효율적으로 비동기 처리하는 방법에 대해 자세히 알게 되었어요.
 - Jetpack Compose Navigaton을 활용하여 싱글 엑티비티에서 다양한 Composable 간의 전환 및 데이터 이동을 가능하게 하는 방법에 대해 알게 되었어요.
+- Jetpack Datastore를 사용하여 사용자 설정과 같은 작은 데이터를 보관하는 로컬 스토리지의 사용법과 활용에 대해 더 자세히 알게 되었어요.
 - GitHub Action를 사용한 CI기능을 구현해 볼 수 있었어요.

app/build.gradle.kts

@@ -11,6 +11,9 @@ plugins {
     alias(libs.plugins.google.gms.google.services)
 
     alias(libs.plugins.kotlinSerialization)
+
+    // KSP Plugin for Room Database
+//    id("com.google.devtools.ksp")
 }
 
 android {
@@ -26,15 +29,21 @@ android {
         applicationId = "com.doyoonkim.knutice"
         minSdk = 29
         targetSdk = 34
-        versionCode = 5
-        versionName = "1.1.0"
+        versionCode = 9
+        versionName = "1.2.0.01"
 
         testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
         vectorDrawables {
             useSupportLibrary = true
         }
 
         buildConfigField("String", "API_ROOT", "\"$apiRoot\"")
+
+        javaCompileOptions {
+            annotationProcessorOptions {
+                arguments["room.schemaLocation"] = "$projectDir/schemas"
+            }
+        }
     }
 
     buildTypes {
@@ -80,6 +89,7 @@ dependencies {
     implementation(libs.androidx.material)
     implementation(libs.firebase.messaging)
     implementation(libs.firebase.messaging.directboot)
+    implementation(libs.androidx.junit.ktx)
     testImplementation(libs.junit)
     testImplementation(libs.kotlinx.coroutines.test)        // Library to test coroutines in JUnit
     androidTestImplementation(libs.androidx.junit)
@@ -110,6 +120,15 @@ dependencies {
     // Jsoup HTML Parser Library
     implementation(libs.jsoup)
 
+    // DataStore
+    implementation (libs.androidx.datastore.preferences)
+
+    // Room Database
+    implementation(libs.androidx.room.runtime)
+    kapt(libs.androidx.room.compiler)
+    // Room Database - Kotlin Extensions and Coroutine Support
+    implementation(libs.androidx.room.ktx)
+
 }
 
 // Allow references to generated code

app/src/main/AndroidManifest.xml

@@ -10,6 +10,7 @@
         android:allowBackup="true"
         android:dataExtractionRules="@xml/data_extraction_rules"
         android:fullBackupContent="@xml/backup_rules"
+        android:usesCleartextTraffic="true"
         android:icon="@mipmap/ic_launcher"
         android:label="@string/app_name"
         android:roundIcon="@mipmap/ic_launcher"

app/src/main/java/com/doyoonkim/knutice/MainApplication.kt

@@ -4,9 +4,7 @@ import android.app.Application
 import android.app.NotificationChannel
 import android.app.NotificationManager
 import android.os.Build
-import androidx.core.content.getSystemService
 import com.doyoonkim.knutice.fcm.PushNotificationHandler
-import com.doyoonkim.knutice.R
 import dagger.hilt.android.HiltAndroidApp
 import javax.inject.Inject
 
@@ -16,21 +14,26 @@ class MainApplication() : Application() {
 
     override fun onCreate() {
         super.onCreate()
-        createNotificationChannel()
+        // Create channel group
+        (getSystemService(NOTIFICATION_SERVICE) as NotificationManager).run {
+            createNotificationChannel(
+                getString(R.string.inapp_notification_channel_id),
+                getString(R.string.inapp_notificaiton_channel_name),
+                getString(R.string.inapp_notification_channel_description)
+            )
+        }
         notificationHandler.requestCurrentToken()
     }
 
     override fun onTerminate() {
         super.onTerminate()
     }
 
-    private fun createNotificationChannel() {
+    private fun createNotificationChannel(id: String, name: String, description: String) {
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
-            val name = getString(R.string.inapp_notificaiton_channel_name)
-            val description = getString(R.string.inapp_notification_channel_description)
             val importance = NotificationManager.IMPORTANCE_DEFAULT
             val channel = NotificationChannel(
-                getString(R.string.inapp_notification_channel_id),
+                id,
                 name,
                 importance
             ).apply {

app/src/main/java/com/doyoonkim/knutice/data/KnuticeRemoteSource.kt

@@ -9,12 +9,13 @@ import com.doyoonkim.knutice.model.TopThreeNotices
 import com.doyoonkim.knutice.model.ApiPostResult
 import com.doyoonkim.knutice.BuildConfig
 import com.doyoonkim.knutice.model.ApiReportRequest
+import com.doyoonkim.knutice.model.ApiTopicSubscriptionRequest
+import com.doyoonkim.knutice.model.ManageTopicRequest
 import com.doyoonkim.knutice.model.ReportRequest
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Deferred
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.async
-import org.jetbrains.annotations.TestOnly
 import org.jsoup.Jsoup
 import retrofit2.Retrofit
 import retrofit2.converter.gson.GsonConverterFactory
@@ -54,6 +55,11 @@ class KnuticeRemoteSource @Inject constructor() {
         }
     }
 
+    suspend fun queryNoticesByKeyword(keyword: String): NoticesPerPage {
+        Log.d("KnuticeRemoteSource", "Start retrofit service (Querying Notices...)")
+        return knuticeService.create(KnuticeService::class.java).queryNoticeByKeyword(keyword)
+    }
+
     suspend fun getFullNoticeContent(url: String): Deferred<String> =
         CoroutineScope(Dispatchers.IO).async {
             Jsoup.connect(url)
@@ -103,6 +109,28 @@ class KnuticeRemoteSource @Inject constructor() {
         }
     }
 
+    suspend fun submitTopicSubscriptionPreference(topic: NoticeCategory, status: Boolean): Result<Boolean> {
+        Log.d("KnuticeRemoteSource", "Update Topic Subscription Preference")
+        try {
+            knuticeService.create(KnuticeService::class.java).submitTopicSubscriptionPreference(
+                ApiTopicSubscriptionRequest(
+                    body = ManageTopicRequest(validatedToken, topic.name, status)
+                )
+            ).run {
+                if (this.result?.resultCode == 200) {
+                    Log.d("KnuticeServer", "Topic preference has been updated.\n${this.body}")
+                    return Result.success(true)
+                } else {
+                    Log.d("KnuticeServer", "Failed to update topic preference.\n${this.body?.message}")
+                    return Result.success(false)
+                }
+            }
+        } catch (e: Exception) {
+            Log.d("KnuticeServer", "Failed to submit user report. \nREASON: ${e.message}")
+            return Result.failure(e)
+        }
+    }
+
 }
 
 interface KnuticeService {
@@ -127,6 +155,11 @@ interface KnuticeService {
         @Query("noticeName") category: NoticeCategory
     ): NoticesPerPage
 
+    @GET("/open-api/search")
+    suspend fun queryNoticeByKeyword(
+        @Query("keyword") keyword: String
+    ): NoticesPerPage
+
     @Headers("Content-Type: application/json")
     @POST("/open-api/token")
     suspend fun validateToken(
@@ -139,4 +172,10 @@ interface KnuticeService {
         @Body requestBody: ApiReportRequest
     ): ApiPostResult
 
+    @Headers("Content-Type: application/json")
+    @POST("/open-api/token/topic")
+    suspend fun submitTopicSubscriptionPreference(
+        @Body requestBody: ApiTopicSubscriptionRequest
+    ): ApiPostResult
+
 }