[#13] Add JsonApi, move dependencies to plugins and minor reviews res…

…olves
nimblehq · Aug 25, 2023 · 84fbc5c · 84fbc5c
1 parent 4c14109
commit 84fbc5c
Show file tree

Hide file tree

Showing 17 changed files with 84 additions and 56 deletions.
diff --git a/android/build.gradle.kts b/android/build.gradle.kts
@@ -1,10 +1,12 @@
+import org.jetbrains.kotlin.konan.properties.loadProperties
+
 plugins {
     id(Plugins.ANDROID_APPLICATION)
     id(Plugins.KOVER)
     kotlin(Plugins.ANDROID)
 }
 
-val keystoreProperties = rootDir.loadGradleProperties("signing.properties")
+val keystoreProperties = loadProperties("$rootDir/signing.properties")
 
 android {
     namespace = "co.nimblehq.kmm.template.android"
@@ -100,7 +102,7 @@ dependencies {
         implementation(COMPOSE)
     }
 
-    with(Dependencies.Logging) {
+    with(Dependencies.Log) {
         implementation(TIMBER)
     }
 

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -1,15 +1,4 @@
-buildscript {
-    repositories {
-        google()
-        mavenCentral()
-    }
-
-    dependencies {
-        classpath(Dependencies.Gradle.BUILD_KONFIG)
-        classpath(Dependencies.Kotlin.KOTLIN_GRADLE_PLUGIN)
-        classpath(Dependencies.Kotlin.KOTLIN_SERIALIZATION)
-    }
-}
+import org.jetbrains.kotlin.konan.properties.loadProperties
 
 plugins {
     //trick: for the same plugin versions in all sub-modules
@@ -18,8 +7,19 @@ plugins {
     id(Plugins.DETEKT) version Versions.DETEKT
     id(Plugins.KOVER) version Versions.KOVER
     id(Plugins.KSP) version Versions.KSP
+    id(Plugins.BUILD_KONFIG) version Versions.BUILD_KONFIG apply (false)
     kotlin(Plugins.ANDROID) version Versions.KOTLIN apply (false)
     kotlin(Plugins.MULTIPLATFORM) version Versions.KOTLIN apply (false)
+    kotlin(Plugins.KOTLIN_SERIALIZATION) version Versions.KOTLIN
+}
+
+allprojects {
+    val buildProperties = loadProperties("$rootDir/buildKonfig.properties")
+    repositories {
+        google()
+        mavenCentral()
+        maven { url = uri("https://jitpack.io") }
+    }
 }
 
 detekt {

diff --git a/buildKonfig.properties.sample b/buildKonfig.properties.sample
@@ -0,0 +1,4 @@
+# Staging env
+STAGING_BASE_URL=
+# Production env
+PRODUCTION_BASE_URL=
diff --git a/buildSrc/src/main/java/Dependencies.kt b/buildSrc/src/main/java/Dependencies.kt
@@ -16,6 +16,7 @@ object Versions {
 
     const val GRADLE = "8.0.2"
 
+    const val JSON_API = "0.1.0"
     const val JUNIT = "4.13.2"
 
     const val KOIN = "3.3.2"
@@ -41,11 +42,6 @@ object Versions {
 }
 
 object Dependencies {
-    object Gradle {
-        const val BUILD_KONFIG = "com.codingfeline.buildkonfig:buildkonfig-gradle-plugin:${Versions.BUILD_KONFIG}"
-
-        const val GRADLE = "com.android.tools.build:gradle:${Versions.GRADLE}"
-    }
 
     object AndroidX {
         const val ACTIVITY_COMPOSE = "androidx.activity:activity-compose:${Versions.ANDROIDX_ACTIVITY_COMPOSE}"
@@ -70,11 +66,6 @@ object Dependencies {
         const val COMPOSE = "io.insert-koin:koin-androidx-compose:${Versions.KOIN_ANDROIDX_COMPOSE}"
     }
 
-    object Kotlin {
-        const val KOTLIN_GRADLE_PLUGIN = "org.jetbrains.kotlin:kotlin-gradle-plugin:${Versions.KOTLIN}"
-        const val KOTLIN_SERIALIZATION = "org.jetbrains.kotlin:kotlin-serialization:${Versions.KOTLIN}"
-    }
-
     object Ktor {
         const val ANDROID = "io.ktor:ktor-client-android:${Versions.KTOR}"
         const val AUTH = "io.ktor:ktor-client-auth:${Versions.KTOR}"
@@ -92,6 +83,11 @@ object Dependencies {
         const val SERIALIZATION = "io.ktor:ktor-client-serialization:${Versions.KTOR}"
     }
 
+    object Log {
+        const val NAPIER = "io.github.aakira:napier:${Versions.NAPIER}"
+        const val TIMBER = "com.jakewharton.timber:timber:${Versions.TIMBER}"
+    }
+
     object Test {
         const val COMPOSE_UI_TEST_JUNIT = "androidx.compose.ui:ui-test-junit4:${Versions.COMPOSE}"
         const val COMPOSE_UI_TEST_MANIFEST = "androidx.compose.ui:ui-test-manifest:${Versions.COMPOSE}"
@@ -111,9 +107,4 @@ object Dependencies {
 
         const val TURBINE = "app.cash.turbine:turbine:${Versions.TURBINE}"
     }
-
-    object Logging {
-        const val NAPIER = "io.github.aakira:napier:${Versions.NAPIER}"
-        const val TIMBER = "com.jakewharton.timber:timber:${Versions.TIMBER}"
-    }
 }
diff --git a/buildSrc/src/main/java/FileExt.kt b/buildSrc/src/main/java/FileExt.kt
diff --git a/detekt.yml b/detekt.yml
@@ -173,7 +173,7 @@ naming:
     minimumFunctionNameLength: 3
   FunctionNaming:
     active: true
-    functionPattern: '[a-zA-Z][a-zA-Z0-9]*'
+    functionPattern: '^([a-z$][a-zA-Z$0-9]*)|(`.*`)$'
     ignoreAnnotated: [ 'Composable' ]
   MatchingDeclarationName:
     active: true

diff --git a/sample/detekt.yml b/sample/detekt.yml
@@ -173,7 +173,7 @@ naming:
     minimumFunctionNameLength: 3
   FunctionNaming:
     active: true
-    functionPattern: '[a-zA-Z][a-zA-Z0-9]*'
+    functionPattern: '^([a-z$][a-zA-Z$0-9]*)|(`.*`)$'
     ignoreAnnotated: [ 'Composable' ]
   MatchingDeclarationName:
     active: true

diff --git a/shared/build.gradle.kts b/shared/build.gradle.kts
@@ -1,5 +1,6 @@
 import org.jetbrains.kotlin.gradle.plugin.mpp.NativeBuildType
 import com.codingfeline.buildkonfig.compiler.FieldSpec.Type.STRING
+import org.jetbrains.kotlin.konan.properties.loadProperties
 
 plugins {
     kotlin(Plugins.MULTIPLATFORM)
@@ -58,7 +59,7 @@ kotlin {
                     implementation(AUTH)
                 }
 
-                implementation(Dependencies.Logging.NAPIER)
+                implementation(Dependencies.Log.NAPIER)
             }
         }
         val commonTest by getting {
@@ -73,13 +74,14 @@ kotlin {
                 }
             }
         }
+
         val androidMain by getting {
             dependencies {
                 implementation(Dependencies.Koin.ANDROID)
-                implementation(Dependencies.Koin.COMPOSE)
                 implementation(Dependencies.Ktor.ANDROID)
             }
         }
+        val androidUnitTest by getting
 
         val iosX64Main by getting
         val iosArm64Main by getting
@@ -93,6 +95,7 @@ kotlin {
                 implementation(Dependencies.Ktor.IOS)
             }
         }
+        val iosTest by getting
     }
 }
 
@@ -122,7 +125,7 @@ android {
     }
 }
 
-val buildKonfigProperties = rootDir.loadGradleProperties("buildKonfig.properties")
+val buildKonfigProperties = loadProperties("$rootDir/buildKonfig.properties")
 buildkonfig {
     packageName = "co.nimblehq.kmm.template"
 

diff --git a/...ommonMain/kotlin/co/nimblehq/kmm/template/data/remote/datasources/UserRemoteDataSource.kt b/...ommonMain/kotlin/co/nimblehq/kmm/template/data/remote/datasources/UserRemoteDataSource.kt
@@ -1,6 +1,6 @@
 package co.nimblehq.kmm.template.data.remote.datasources
 
-import co.nimblehq.kmm.template.data.remote.model.response.UserResponse
+import co.nimblehq.kmm.template.data.remote.model.responses.UserResponse
 import co.nimblehq.kmm.template.data.remote.ApiClient
 
 interface UserRemoteDataSource {

diff --git a/...ata/remote/model/response/UserResponse.kt → ...ta/remote/model/responses/UserResponse.kt b/...ata/remote/model/response/UserResponse.kt → ...ta/remote/model/responses/UserResponse.kt
@@ -1,4 +1,4 @@
-package co.nimblehq.kmm.template.data.remote.model.response
+package co.nimblehq.kmm.template.data.remote.model.responses
 
 import co.nimblehq.kmm.template.domain.model.UserModel
 import kotlinx.serialization.SerialName

diff --git a/...emplate/data/repository/RepositoryImpl.kt → ...plate/data/repositories/RepositoryImpl.kt b/...emplate/data/repository/RepositoryImpl.kt → ...plate/data/repositories/RepositoryImpl.kt
@@ -1,8 +1,8 @@
-package co.nimblehq.kmm.template.data.repository
+package co.nimblehq.kmm.template.data.repositories
 
 import co.nimblehq.kmm.template.data.extensions.flowTransform
 import co.nimblehq.kmm.template.data.remote.datasources.UserRemoteDataSource
-import co.nimblehq.kmm.template.data.remote.model.response.toModel
+import co.nimblehq.kmm.template.data.remote.model.responses.toModel
 import co.nimblehq.kmm.template.domain.model.UserModel
 import co.nimblehq.kmm.template.domain.repositories.Repository
 import kotlinx.coroutines.flow.Flow

diff --git a/shared/src/commonMain/kotlin/co/nimblehq/kmm/template/di/module/RepositoryModule.kt b/shared/src/commonMain/kotlin/co/nimblehq/kmm/template/di/module/RepositoryModule.kt
@@ -2,7 +2,7 @@ package co.nimblehq.kmm.template.di.module
 
 import org.koin.core.module.dsl.singleOf
 import org.koin.dsl.module
-import co.nimblehq.kmm.template.data.repository.RepositoryImpl
+import co.nimblehq.kmm.template.data.repositories.RepositoryImpl
 import co.nimblehq.kmm.template.domain.repositories.Repository
 import org.koin.dsl.bind
 

diff --git a/shared/src/commonMain/kotlin/co/nimblehq/kmm/template/domain/exceptions/ApiException.kt b/shared/src/commonMain/kotlin/co/nimblehq/kmm/template/domain/exceptions/ApiException.kt
@@ -0,0 +1,7 @@
+package co.nimblehq.kmm.template.domain.exceptions
+
+data class ApiException(
+    val code: String?,
+    override val message: String?,
+    override val cause: Throwable? = null
+) : RuntimeException(message, cause)
diff --git a/...emplate/data/repository/RepositoryTest.kt → ...plate/data/repositories/RepositoryTest.kt b/...emplate/data/repository/RepositoryTest.kt → ...plate/data/repositories/RepositoryTest.kt
@@ -1,4 +1,4 @@
-package co.nimblehq.kmm.template.data.repository
+package co.nimblehq.kmm.template.data.repositories
 
 import app.cash.turbine.test
 import co.nimblehq.kmm.template.data.remote.datasources.UserRemoteDataSource

diff --git a/shared/src/commonTest/kotlin/co/nimblehq/kmm/template/domain/usecases/GetUsersUseCaseTest.kt b/shared/src/commonTest/kotlin/co/nimblehq/kmm/template/domain/usecases/GetUsersUseCaseTest.kt
@@ -21,12 +21,12 @@ class GetUsersUseCaseTest {
     private lateinit var useCase: GetUsersUseCase
 
     @BeforeTest
-    fun setup() {
+    fun setUp() {
         useCase = GetUsersUseCaseImpl(mockRepository)
     }
 
     @Test
-    fun `When calling getUsersUseCase successfully - it returns users`() = runTest {
+    fun `When calling getUsers successfully - it returns users`() = runTest {
         given(mockRepository)
             .function(mockRepository::getUsers)
             .whenInvoked()
@@ -39,7 +39,7 @@ class GetUsersUseCaseTest {
     }
 
     @Test
-    fun `when calling getUsersUseCase fails - it throws the corresponding error`() = runTest {
+    fun `when calling getUsers fails - it throws the corresponding error`() = runTest {
         val throwable = Throwable()
         given(mockRepository)
             .function(mockRepository::getUsers)

diff --git a/shared/src/commonTest/kotlin/co/nimblehq/kmm/template/extensions/ResponseMappingTest.kt b/shared/src/commonTest/kotlin/co/nimblehq/kmm/template/extensions/ResponseMappingTest.kt
@@ -0,0 +1,33 @@
+package co.nimblehq.kmm.template.extensions
+
+import app.cash.turbine.test
+import co.nimblehq.kmm.template.data.extensions.flowTransform
+import co.nimblehq.kmm.template.domain.model.UserModel
+import io.kotest.matchers.shouldBe
+import io.ktor.utils.io.errors.*
+import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.test.runTest
+import kotlin.test.Test
+
+@ExperimentalCoroutinesApi
+class ResponseMappingTest {
+
+    @Test
+    fun `When mapping API request flow failed with Exception - it returns Exception error`() = runTest {
+        flowTransform<UserModel> {
+            throw Exception()
+        }.test {
+            awaitError() shouldBe Exception()
+        }
+    }
+
+    @Test
+    fun `When mapping API request flow failed with a generic error - it returns that error`() = runTest {
+        val error = IOException("no internet")
+        flowTransform<UserModel> {
+            throw error
+        }.test {
+            awaitError() shouldBe error
+        }
+    }
+}
diff --git a/shared/src/commonTest/kotlin/co/nimblehq/kmm/template/util/Fake.kt b/shared/src/commonTest/kotlin/co/nimblehq/kmm/template/util/Fake.kt
@@ -1,6 +1,6 @@
 package co.nimblehq.kmm.template.util
 
-import co.nimblehq.kmm.template.data.remote.model.response.UserResponse
+import co.nimblehq.kmm.template.data.remote.model.responses.UserResponse
 import co.nimblehq.kmm.template.domain.model.UserModel
 
 object Fake {