Fix #19: Implement complete notification screen with UI, API integration, and tests (#22)

<!-- This will be automatically replaced by a summary generated by
CodeRabbitAI -->
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Introduced a new notification UI with dynamic icons, relative time
formatting, and improved list display.
* Added support for handling notification actions and events, including
error states.
  * Implemented a view model to manage notification state and actions.
  * Added new drawable icons for discussions, issues, and pull requests.
  * Added a concise relative time display for notifications.

* **Improvements**
* Enhanced notification data handling to support nullable fields and
improved URL mapping.
  * Refined dependency injection for notification data sources.
* Updated notification retrieval to allow filtering of read/unread
notifications.
* Improved loading state handling and UI feedback during notification
fetch.
  * Optimized HTTP client configuration for network requests.

* **Bug Fixes**
* Improved robustness by making certain fields nullable to handle
missing data gracefully.

* **Tests**
  * Added comprehensive unit tests for relative time string formatting.

* **Refactor**
* Restructured domain models and updated package organization for
clarity and maintainability.

* **Documentation**
  * Updated function and parameter documentation for clarity.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

## Issue Reference
* Fixes #19

## Screenshots
<!-- Upload before-and-after screenshots for UI-related changes. Include
both light and dark mode views if relevant. -->

_TODO_: Add screenshots

## Essential Checklist
<!-- Please tick the relevant boxes by putting an "x" in them (and
remove additional spaces). -->
* [x] The PR title starts with "Fix #bugnum: " (If this PR fixes part of
an issue, prefix the title with "Fix part of #bugnum: ...").
* [x] The PR does not contain any unnecessary code changes from Android
Studio.
* [x] The PR is made from a branch that is **not** called "main" and is
up-to-date with "main".

Author: theMr17

app/src/androidTest/java/com/notifier/app/core/presentation/notification/FakeNotificationPermissionState.kt

@@ -11,8 +11,10 @@ package com.notifier.app.core.presentation.notification
  */
 class FakeNotificationPermissionState(
     override val isGranted: Boolean,
-    override val shouldShowRationale: Boolean
+    override val shouldShowRationale: Boolean,
 ) : NotificationPermissionState {
     /** No-op implementation since this is only used in tests. */
-    override fun requestPermission() { /* No-op for tests */ }
+    override fun requestPermission() {
+        /* No-op for tests */
+    }
 }

app/src/main/java/com/notifier/app/core/data/networking/HttpClientFactory.kt

@@ -11,10 +11,10 @@ import io.ktor.client.plugins.logging.ANDROID
 import io.ktor.client.plugins.logging.LogLevel
 import io.ktor.client.plugins.logging.Logger
 import io.ktor.client.plugins.logging.Logging
+import io.ktor.client.request.header
 import io.ktor.http.ContentType
 import io.ktor.http.HttpHeaders
 import io.ktor.http.contentType
-import io.ktor.http.headers
 import io.ktor.serialization.kotlinx.json.json
 import kotlinx.coroutines.runBlocking
 import kotlinx.serialization.json.Json
@@ -61,19 +61,17 @@ class HttpClientFactory @Inject constructor(
         // Set default request headers and properties
         defaultRequest {
             contentType(ContentType.Application.Json)
-        }
 
-        val accessToken = runBlocking {
-            var retrievedToken = ""
-            dataStoreManager.getAccessToken().onSuccess {
-                retrievedToken = it
+            val accessToken = runBlocking {
+                var retrievedToken = ""
+                dataStoreManager.getAccessToken().onSuccess {
+                    retrievedToken = it
+                }
+                return@runBlocking retrievedToken
             }
-            return@runBlocking retrievedToken
-        }
 
-        headers {
-            append(HttpHeaders.Authorization, "Bearer $accessToken")
-            append("X-GitHub-Api-Version", "2022-11-28")
+            header(HttpHeaders.Authorization, "Bearer $accessToken")
+            header("X-GitHub-Api-Version", "2022-11-28")
         }
     }
 }

app/src/main/java/com/notifier/app/core/presentation/notification/WithNotificationPermission.kt

@@ -67,7 +67,7 @@ fun WithNotificationPermission(
  */
 @Composable
 private fun NotificationPermissionHandler(
-    permissionState: NotificationPermissionState
+    permissionState: NotificationPermissionState,
 ) {
     val context = LocalContext.current
     var hasRequested by rememberSaveable { mutableStateOf(false) }

app/src/main/java/com/notifier/app/core/presentation/util/ZonedDateTimeToRelativeString.kt

@@ -0,0 +1,26 @@
+package com.notifier.app.core.presentation.util
+
+import java.time.Duration
+import java.time.ZonedDateTime
+import kotlin.math.abs
+
+fun ZonedDateTime.toRelativeTimeString(): String {
+    val now = ZonedDateTime.now()
+    val duration = Duration.between(this, now)
+    val seconds = duration.seconds
+
+    val absSeconds = abs(seconds)
+
+    val minute = 60
+    val hour = 60 * minute
+    val day = 24 * hour
+    val week = 7 * day
+
+    return when {
+        absSeconds < minute -> "${absSeconds}s"
+        absSeconds < hour -> "${absSeconds / minute}m"
+        absSeconds < day -> "${absSeconds / hour}h"
+        absSeconds < week -> "${absSeconds / day}d"
+        else -> "${absSeconds / week}w"
+    }
+}

app/src/main/java/com/notifier/app/di/ApiModule.kt

@@ -3,6 +3,8 @@ package com.notifier.app.di
 import com.notifier.app.auth.data.networking.RemoteAuthTokenDataSource
 import com.notifier.app.auth.domain.AuthTokenDataSource
 import com.notifier.app.core.data.networking.HttpClientFactory
+import com.notifier.app.notification.data.networking.RemoteNotificationDataSource
+import com.notifier.app.notification.domain.NotificationDataSource
 import dagger.Module
 import dagger.Provides
 import dagger.hilt.InstallIn
@@ -29,4 +31,12 @@ object ApiModule {
     ): AuthTokenDataSource {
         return RemoteAuthTokenDataSource(httpClient)
     }
+
+    @Provides
+    @Singleton
+    fun provideRemoteNotificationDataSource(
+        httpClient: HttpClient,
+    ): NotificationDataSource {
+        return RemoteNotificationDataSource(httpClient)
+    }
 }

app/src/main/java/com/notifier/app/notification/data/mappers/NotificationMapper.kt

@@ -5,10 +5,10 @@ import com.notifier.app.notification.data.networking.dto.OwnerDto
 import com.notifier.app.notification.data.networking.dto.RepositoryDto
 import com.notifier.app.notification.data.networking.dto.SubjectDto
 import com.notifier.app.notification.data.util.toZonedDateTimeOrDefault
-import com.notifier.app.notification.domain.Notification
-import com.notifier.app.notification.domain.Owner
-import com.notifier.app.notification.domain.Repository
-import com.notifier.app.notification.domain.Subject
+import com.notifier.app.notification.domain.model.Notification
+import com.notifier.app.notification.domain.model.Owner
+import com.notifier.app.notification.domain.model.Repository
+import com.notifier.app.notification.domain.model.Subject
 
 fun NotificationDto.toNotification() = Notification(
     id = id,

app/src/main/java/com/notifier/app/notification/data/networking/RemoteNotificationDataSource.kt

@@ -6,9 +6,9 @@ import com.notifier.app.core.domain.util.NetworkError
 import com.notifier.app.core.domain.util.Result
 import com.notifier.app.core.domain.util.map
 import com.notifier.app.notification.data.mappers.toNotification
-import com.notifier.app.notification.data.networking.dto.NotificationResponseDto
-import com.notifier.app.notification.domain.Notification
+import com.notifier.app.notification.data.networking.dto.NotificationDto
 import com.notifier.app.notification.domain.NotificationDataSource
+import com.notifier.app.notification.domain.model.Notification
 import io.ktor.client.HttpClient
 import io.ktor.client.request.get
 
@@ -34,13 +34,18 @@ class RemoteNotificationDataSource(
      * @return A [Result] containing either a list of [Notification] objects on success, or a
      * [NetworkError] on failure.
      */
-    override suspend fun getNotifications(): Result<List<Notification>, NetworkError> {
-        return safeCall<NotificationResponseDto> {
+    override suspend fun getNotifications(includeRead: Boolean): Result<List<Notification>,
+            NetworkError> {
+        return safeCall<List<NotificationDto>> {
             httpClient.get(
-                urlString = constructUrl("/notification")
-            )
+                urlString = constructUrl("/notifications")
+            ) {
+                url {
+                    parameters.append("all", includeRead.toString())
+                }
+            }
         }.map { response ->
-            response.data.map { it.toNotification() }
+            response.map { it.toNotification() }
         }
     }
 }

app/src/main/java/com/notifier/app/notification/data/networking/dto/NotificationDto.kt

@@ -8,7 +8,7 @@ data class NotificationDto(
     @SerialName("id")
     val id: String,
     @SerialName("last_read_at")
-    val lastReadAt: String,
+    val lastReadAt: String?,
     @SerialName("reason")
     val reason: String,
     @SerialName("repository")

app/src/main/java/com/notifier/app/notification/data/networking/dto/RepositoryDto.kt

@@ -45,8 +45,6 @@ data class RepositoryDto(
     val gitRefsUrl: String,
     @SerialName("git_tags_url")
     val gitTagsUrl: String,
-    @SerialName("git_url")
-    val gitUrl: String,
     @SerialName("hooks_url")
     val hooksUrl: String,
     @SerialName("html_url")
@@ -83,8 +81,6 @@ data class RepositoryDto(
     val pullsUrl: String,
     @SerialName("releases_url")
     val releasesUrl: String,
-    @SerialName("ssh_url")
-    val sshUrl: String,
     @SerialName("stargazers_url")
     val stargazersUrl: String,
     @SerialName("statuses_url")

app/src/main/java/com/notifier/app/notification/data/networking/dto/SubjectDto.kt

@@ -6,7 +6,7 @@ import kotlinx.serialization.Serializable
 @Serializable
 data class SubjectDto(
     @SerialName("latest_comment_url")
-    val latestCommentUrl: String,
+    val latestCommentUrl: String?,
     @SerialName("title")
     val title: String,
     @SerialName("type")