openium/consentium.droid
0
0
Fork 0
Code Pull Requests Releases Activity

feat(CON-206) : [UI] - Create Data / Domain layer to retrive the configuration.

Browse Source
This commit is contained in:
Louis Legrand 2024-12-13 15:13:23 +01:00
parent f4949c2852
commit 56aeae61de
31 changed files with 485 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
consentium-ui/build.gradle.kts
View File

@ -1,6 +1,8 @@
plugins {
alias(libs.plugins.android.library)
alias(libs.plugins.kotlin.android)
alias(libs.plugins.serialization)
alias(libs.plugins.ksp)
}
android {
@ -37,6 +39,21 @@ dependencies {
implementation(libs.androidx.core.ktx)
implementation(libs.androidx.appcompat)
// Serialization
implementation(libs.kotlin.serialization)
// Retrofit
api(libs.retrofit)
implementation(libs.retrofitConverter)
implementation(libs.logging.interceptor)
// Hilt
implementation(libs.hilt.android)
ksp(libs.hilt.compiler)
// Timber
implementation(libs.timber)
// Tests
testImplementation(libs.test.junit)
androidTestImplementation(libs.androidx.junit)

49
consentium-ui/src/main/java/fr/openium/consentium_ui/data/di/NetworkModule.kt Normal file
View File

@ -0,0 +1,49 @@
package fr.openium.consentium_ui.data.di
import dagger.Lazy
import dagger.Module
import dagger.Provides
import dagger.Reusable
import dagger.hilt.InstallIn
import dagger.hilt.components.SingletonComponent
import fr.openium.consentium.data.di.ConsentiumUrl
import fr.openium.consentium.data.di.OkHttpClientDefault
import fr.openium.consentium_ui.data.remote.ConsentiumUIApi
import kotlinx.serialization.json.Json
import okhttp3.HttpUrl
import okhttp3.MediaType.Companion.toMediaType
import okhttp3.OkHttpClient
import retrofit2.Retrofit
import retrofit2.converter.kotlinx.serialization.asConverterFactory
private val json by lazy {
Json {
isLenient = true
ignoreUnknownKeys = true
}
}
@Module
@InstallIn(SingletonComponent::class)
internal object NetworkModule {
@Reusable
@Provides
fun provideConsentiumUIApi(
@ConsentiumUrl url: HttpUrl,
@OkHttpClientDefault okHttpClient: Lazy<OkHttpClient>,
): ConsentiumUIApi =
createRetrofit(
url,
okHttpClient
).create(ConsentiumUIApi::class.java)
private fun createRetrofit(url: HttpUrl, okHttpClient: Lazy<OkHttpClient>): Retrofit =
Retrofit.Builder()
.callFactory { request ->
okHttpClient.get().newCall(request)
}.addConverterFactory(json.asConverterFactory("application/json".toMediaType()))
.baseUrl(url)
.build()
}

15
consentium-ui/src/main/java/fr/openium/consentium_ui/data/remote/ConsentiumUIApi.kt Normal file
View File

@ -0,0 +1,15 @@
package fr.openium.consentium_ui.data.remote
import fr.openium.consentium_ui.data.remote.model.GetConsentConfigDTO
import retrofit2.Response
import retrofit2.http.GET
internal interface ConsentiumUIApi {
@GET("consent-config")
suspend fun getConsentConfig(
applicationID: String,
installationID: String,
): Response<GetConsentConfigDTO>
}

16
consentium-ui/src/main/java/fr/openium/consentium_ui/data/remote/model/GetConsentConfigDTO.kt Normal file
View File

@ -0,0 +1,16 @@
package fr.openium.consentium_ui.data.remote.model
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
@Serializable
internal data class GetConsentConfigDTO(
@SerialName("id") val installationId: String,
@SerialName("name") val appName: String,
@SerialName("icon") val icon: String,
@SerialName("primaryColor") val primaryColor: String,
@SerialName("secondaryColor") val secondaryColor: String,
@SerialName("textColor") val textColor: String,
@SerialName("translation") val consentMainTextTranslation: List<MainConsentTextTranslationDTO>,
@SerialName("purposes") val purposes: List<PurposeDTO>,
)

13
consentium-ui/src/main/java/fr/openium/consentium_ui/data/remote/model/MainConsentTextTranslationDTO.kt Normal file
View File

@ -0,0 +1,13 @@
package fr.openium.consentium_ui.data.remote.model
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
@Serializable
internal data class MainConsentTextTranslationDTO(
@SerialName("id") val id: String,
@SerialName("lang") val language: String,
@SerialName("consentPageUrl") val consentPageUrl: String,
@SerialName("mainConsentText") val mainConsentText: String,
@SerialName("durationText") val durationText: String,
)

14
consentium-ui/src/main/java/fr/openium/consentium_ui/data/remote/model/PurposeDTO.kt Normal file
View File

@ -0,0 +1,14 @@
package fr.openium.consentium_ui.data.remote.model
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
@Serializable
internal data class PurposeDTO(
@SerialName("identifier") val id: String,
@SerialName("order") val order: Int,
@SerialName("isRequired") val isRequired: Boolean,
@SerialName("isAccepted") val isAccepted: Boolean,
@SerialName("translations") val translations: List<PurposeTranslationDTO>,
@SerialName("vendors") val vendors: List<VendorDTO>,
)

11
consentium-ui/src/main/java/fr/openium/consentium_ui/data/remote/model/PurposeTranslationDTO.kt Normal file
View File

@ -0,0 +1,11 @@
package fr.openium.consentium_ui.data.remote.model
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
@Serializable
internal data class PurposeTranslationDTO(
@SerialName("id") val id: String,
@SerialName("lang") val language: String,
@SerialName("text") val text: String,
)

13
consentium-ui/src/main/java/fr/openium/consentium_ui/data/remote/model/VendorDTO.kt Normal file
View File

@ -0,0 +1,13 @@
package fr.openium.consentium_ui.data.remote.model
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
@Serializable
internal data class VendorDTO(
@SerialName("identifier") val id: String,
@SerialName("order") val order: Int,
@SerialName("isRequired") val isRequired: Boolean,
@SerialName("isAccepted") val isAccepted: Boolean,
@SerialName("translations") val translations: List<VendorTranslationDTO>,
)

11
consentium-ui/src/main/java/fr/openium/consentium_ui/data/remote/model/VendorTranslationDTO.kt Normal file
View File

@ -0,0 +1,11 @@
package fr.openium.consentium_ui.data.remote.model
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
@Serializable
internal data class VendorTranslationDTO(
@SerialName("id") val id: String,
@SerialName("lang") val language: String,
@SerialName("text") val text: String,
)

12
consentium-ui/src/main/java/fr/openium/consentium_ui/domain/adapter/ConsentConfigDataAdapter.kt Normal file
View File

@ -0,0 +1,12 @@
package fr.openium.consentium_ui.domain.adapter
import fr.openium.consentium_ui.data.remote.model.GetConsentConfigDTO
import fr.openium.consentium_ui.domain.model.ContentConfigData
internal fun GetConsentConfigDTO.toConsentConfigData() =
ContentConfigData(
applicationName = appName,
iconUrl = icon,
mainTextTranslation = consentMainTextTranslation.toMainConsentTextTranslationDataList(),
purposes = purposes.toPurposeDataList()
)

15
consentium-ui/src/main/java/fr/openium/consentium_ui/domain/adapter/MainConsentTextTranslationDataAdapter.kt Normal file
View File

@ -0,0 +1,15 @@
package fr.openium.consentium_ui.domain.adapter
import fr.openium.consentium_ui.data.remote.model.MainConsentTextTranslationDTO
import fr.openium.consentium_ui.domain.model.MainConsentTextTranslationData
internal fun MainConsentTextTranslationDTO.toMainConsentTextTranslationData() =
MainConsentTextTranslationData(
id = id,
language = language,
consentPageUrl = consentPageUrl,
mainConsentText = mainConsentText,
durationText = durationText,
)
internal fun List<MainConsentTextTranslationDTO>.toMainConsentTextTranslationDataList() = map { it.toMainConsentTextTranslationData() }

16
consentium-ui/src/main/java/fr/openium/consentium_ui/domain/adapter/PurposeDataAdapter.kt Normal file
View File

@ -0,0 +1,16 @@
package fr.openium.consentium_ui.domain.adapter
import fr.openium.consentium_ui.data.remote.model.PurposeDTO
import fr.openium.consentium_ui.domain.model.PurposeData
internal fun PurposeDTO.toPurposeData() =
PurposeData(
identifier = id,
isRequired = isRequired,
isAccepted = isAccepted,
order = order,
vendors = vendors.toVendorDataList(),
translations = translations.toPurposeTranslationDataList(),
)
internal fun List<PurposeDTO>.toPurposeDataList() = map { it.toPurposeData() }

13
consentium-ui/src/main/java/fr/openium/consentium_ui/domain/adapter/PurposeTranslationDataAdapter.kt Normal file
View File

@ -0,0 +1,13 @@
package fr.openium.consentium_ui.domain.adapter
import fr.openium.consentium_ui.data.remote.model.PurposeTranslationDTO
import fr.openium.consentium_ui.domain.model.PurposeTranslationData
internal fun PurposeTranslationDTO.toPurposeTranslationData() =
PurposeTranslationData(
id = id,
language = language,
text = text,
)
internal fun List<PurposeTranslationDTO>.toPurposeTranslationDataList() = map { it.toPurposeTranslationData() }

15
consentium-ui/src/main/java/fr/openium/consentium_ui/domain/adapter/VendorDataAdapter.kt Normal file
View File

@ -0,0 +1,15 @@
package fr.openium.consentium_ui.domain.adapter
import fr.openium.consentium_ui.data.remote.model.VendorDTO
import fr.openium.consentium_ui.domain.model.VendorData
internal fun VendorDTO.toVendorData() =
VendorData(
identifier = id,
order = order,
isRequired = isRequired,
isAccepted = isAccepted,
translations = translations.toVendorTranslationDataList(),
)
internal fun List<VendorDTO>.toVendorDataList() = map { it.toVendorData() }

13
consentium-ui/src/main/java/fr/openium/consentium_ui/domain/adapter/VendorTranslationDataAdapter.kt Normal file
View File

@ -0,0 +1,13 @@
package fr.openium.consentium_ui.domain.adapter
import fr.openium.consentium_ui.data.remote.model.VendorTranslationDTO
import fr.openium.consentium_ui.domain.model.VendorTranslationData
internal fun VendorTranslationDTO.toVendorTranslationData() =
VendorTranslationData(
id = id,
language = language,
text = text,
)
internal fun List<VendorTranslationDTO>.toVendorTranslationDataList() = map { it.toVendorTranslationData() }

19
consentium-ui/src/main/java/fr/openium/consentium_ui/domain/di/ConsentiumUseCaseModule.kt Normal file
View File

@ -0,0 +1,19 @@
package fr.openium.consentium_ui.domain.di
import dagger.Binds
import dagger.Module
import dagger.hilt.InstallIn
import dagger.hilt.components.SingletonComponent
import fr.openium.consentium_ui.domain.usecase.GetConfigTextForLanguageUseCase
import fr.openium.consentium_ui.domain.usecase.GetConfigTextForLanguageUseCaseImpl
@Module
@InstallIn(SingletonComponent::class)
internal interface ConsentiumUseCaseModule {
@Binds
fun bindsGetConfigTextForLanguageUseCase(
getConfigTextForLanguageUseCaseImpl: GetConfigTextForLanguageUseCaseImpl,
): GetConfigTextForLanguageUseCase
}

8
consentium-ui/src/main/java/fr/openium/consentium_ui/domain/model/ContentConfigData.kt Normal file
View File

@ -0,0 +1,8 @@
package fr.openium.consentium_ui.domain.model
internal data class ContentConfigData(
val applicationName: String,
val iconUrl : String,
val mainTextTranslation: List<MainConsentTextTranslationData>,
val purposes: List<PurposeData>
)

9
consentium-ui/src/main/java/fr/openium/consentium_ui/domain/model/MainConsentTextTranslationData.kt Normal file
View File

@ -0,0 +1,9 @@
package fr.openium.consentium_ui.domain.model
internal data class MainConsentTextTranslationData(
val id: String,
val language: String,
val consentPageUrl: String,
val mainConsentText: String,
val durationText: String,
)

10
consentium-ui/src/main/java/fr/openium/consentium_ui/domain/model/PurposeData.kt Normal file
View File

@ -0,0 +1,10 @@
package fr.openium.consentium_ui.domain.model
internal data class PurposeData(
val identifier: String,
val order: Int,
val isRequired: Boolean,
val isAccepted: Boolean,
val translations: List<PurposeTranslationData>,
val vendors: List<VendorData>,
)

7
consentium-ui/src/main/java/fr/openium/consentium_ui/domain/model/PurposeTranslationData.kt Normal file
View File

@ -0,0 +1,7 @@
package fr.openium.consentium_ui.domain.model
internal data class PurposeTranslationData(
val id: String,
val language: String,
val text: String,
)

9
consentium-ui/src/main/java/fr/openium/consentium_ui/domain/model/VendorData.kt Normal file
View File

@ -0,0 +1,9 @@
package fr.openium.consentium_ui.domain.model
internal data class VendorData(
val identifier: String,
val order: Int,
val isRequired: Boolean,
val isAccepted: Boolean,
val translations: List<VendorTranslationData>,
)

7
consentium-ui/src/main/java/fr/openium/consentium_ui/domain/model/VendorTranslationData.kt Normal file
View File

@ -0,0 +1,7 @@
package fr.openium.consentium_ui.domain.model
internal data class VendorTranslationData(
val id: String,
val language: String,
val text: String,
)

41
consentium-ui/src/main/java/fr/openium/consentium_ui/domain/repository/ConsentiumUIRepository.kt Normal file
View File

@ -0,0 +1,41 @@
package fr.openium.consentium_ui.domain.repository
import fr.openium.consentium.domain.useCase.GetConsentiumUniqueInstallationIdUseCase
import fr.openium.consentium_ui.data.remote.ConsentiumUIApi
import fr.openium.consentium_ui.domain.adapter.toConsentConfigData
import fr.openium.consentium_ui.domain.model.ContentConfigData
import javax.inject.Inject
internal class ConsentiumRepository @Inject constructor(
private val getConsentiumUniqueInstallationIdUseCase: GetConsentiumUniqueInstallationIdUseCase,
private val consentiumUIApi: ConsentiumUIApi,
) {
suspend fun getConsentiumConfig(
applicationId: String,
): ConsentiumUIRepositoryResponse {
val installationId = getConsentiumUniqueInstallationIdUseCase.invoke()
val consentsResponse = consentiumUIApi.getConsentConfig(applicationId, installationId)
return try {
val consentsBody = if (consentsResponse.isSuccessful) {
consentsResponse.body() ?: throw Exception()
} else {
throw Exception()
}
ConsentiumUIRepositoryResponse.Success(consentsBody.toConsentConfigData())
} catch (e: Exception) {
ConsentiumUIRepositoryResponse.Error
}
}
}
internal interface ConsentiumUIRepositoryResponse {
data object Error : ConsentiumUIRepositoryResponse
data class Success(val contentConfigData: ContentConfigData) : ConsentiumUIRepositoryResponse
}

83
consentium-ui/src/main/java/fr/openium/consentium_ui/domain/usecase/GetConfigTextForLanguage.kt Normal file
View File

@ -0,0 +1,83 @@
package fr.openium.consentium_ui.domain.usecase
import fr.openium.consentium_ui.domain.model.ContentConfigData
import javax.inject.Inject
private const val FALLBACK_LANGUAGE = "en"
internal interface GetConfigTextForLanguageUseCase {
suspend fun invoke(
language: String = FALLBACK_LANGUAGE,
configData: ContentConfigData,
): GetConfigTextForLanguageUseCaseResponce
}
internal class GetConfigTextForLanguageUseCaseImpl @Inject constructor() : GetConfigTextForLanguageUseCase {
override suspend fun invoke(
language: String,
configData: ContentConfigData,
): GetConfigTextForLanguageUseCaseResponce {
return try {
val canIUseTheTranslation = configData.mainTextTranslation.any { it.language == language } &&
configData.purposes.all { purposeData ->
purposeData.translations.any { it.language == language } &&
purposeData.vendors.all { vendorData ->
vendorData.translations.any { it.language == language }
}
}
val languageToUse = if (canIUseTheTranslation) {
language
} else {
val isThereAGoodFallbackLanguage = configData.mainTextTranslation.any { it.language == FALLBACK_LANGUAGE } &&
configData.purposes.all { purposeData ->
purposeData.translations.any { it.language == FALLBACK_LANGUAGE } &&
purposeData.vendors.all { vendorData ->
vendorData.translations.any { it.language == FALLBACK_LANGUAGE }
}
}
if (isThereAGoodFallbackLanguage) {
FALLBACK_LANGUAGE
} else {
throw Exception()
}
}
val filteredConfigData = configData.copy(
mainTextTranslation = configData.mainTextTranslation.filter { it.language == languageToUse },
purposes = configData.purposes.map { purposeData ->
purposeData.copy(
translations = purposeData.translations.filter { it.language == languageToUse },
vendors = purposeData.vendors.map { vendorData ->
vendorData.copy(
translations = vendorData.translations.filter { it.language == languageToUse }
)
}
)
}
)
if (languageToUse == FALLBACK_LANGUAGE) {
GetConfigTextForLanguageUseCaseResponce.DefaultLanguage(filteredConfigData)
} else {
GetConfigTextForLanguageUseCaseResponce.Success(filteredConfigData)
}
} catch (e: Exception) {
GetConfigTextForLanguageUseCaseResponce.Error
}
}
}
internal interface GetConfigTextForLanguageUseCaseResponce {
data object Error : GetConfigTextForLanguageUseCaseResponce
data class Success(val configData: ContentConfigData) : GetConfigTextForLanguageUseCaseResponce
data class DefaultLanguage(val configData: ContentConfigData) : GetConfigTextForLanguageUseCaseResponce
}

2
consentium/src/debug/kotlin/fr/openium/consentium/DebugNetworkModule.kt → consentium/src/debug/kotlin/fr/openium/consentium/ConsentiumDebugNetworkModule.kt
View File

@ -16,7 +16,7 @@ import timber.log.Timber
@Module
@InstallIn(SingletonComponent::class)
class DebugNetworkModule {
class ConsentiumDebugNetworkModule {
@Provides
fun provideOkHttpBuilder(

8
consentium/src/main/java/fr/openium/consentium/api/Consentium.kt
View File

@ -9,10 +9,10 @@ import fr.openium.consentium.api.model.VendorIdentifier
import fr.openium.consentium.api.model.VendorStatus
import fr.openium.consentium.api.state.FetchConsentiumState
import fr.openium.consentium.api.state.SetConsentiumState
import fr.openium.consentium.data.di.RepositoryEntryPoint
import fr.openium.consentium.data.repository.ConsentiumRepository
import fr.openium.consentium.data.repository.ConsentiumRepositoryGetResponse
import fr.openium.consentium.data.repository.ConsentiumRepositorySetResponse
import fr.openium.consentium.domain.di.RepositoryEntryPoint
import fr.openium.consentium.domain.repository.ConsentiumRepository
import fr.openium.consentium.domain.repository.ConsentiumRepositoryGetResponse
import fr.openium.consentium.domain.repository.ConsentiumRepositorySetResponse
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.asStateFlow

8
consentium/src/main/java/fr/openium/consentium/data/di/NetworkModule.kt
View File

@ -28,7 +28,7 @@ private val json by lazy {
@Module
@InstallIn(SingletonComponent::class)
internal object NetworkModule {
object NetworkModule {
@OkHttpClientDefault
@Provides
@ -51,7 +51,7 @@ internal object NetworkModule {
@Reusable
@Provides
fun provideConsentiumApi(
internal fun provideConsentiumApi(
@ConsentiumUrl url: HttpUrl,
@OkHttpClientDefault okHttpClient: Lazy<OkHttpClient>,
): ConsentiumApi =
@ -71,8 +71,8 @@ internal object NetworkModule {
@Qualifier
@Retention(AnnotationRetention.BINARY)
internal annotation class ConsentiumUrl
annotation class ConsentiumUrl
@Qualifier
@Retention(AnnotationRetention.BINARY)
internal annotation class OkHttpClientDefault
annotation class OkHttpClientDefault

4
consentium/src/main/java/fr/openium/consentium/data/di/RepositoryEntryPoint.kt → consentium/src/main/java/fr/openium/consentium/domain/di/RepositoryEntryPoint.kt
View File

@ -1,9 +1,9 @@
package fr.openium.consentium.data.di
package fr.openium.consentium.domain.di
import dagger.hilt.EntryPoint
import dagger.hilt.InstallIn
import dagger.hilt.components.SingletonComponent
import fr.openium.consentium.data.repository.ConsentiumRepository
import fr.openium.consentium.domain.repository.ConsentiumRepository
@EntryPoint
@InstallIn(SingletonComponent::class)

2
consentium/src/main/java/fr/openium/consentium/data/repository/ConsentiumRepository.kt → consentium/src/main/java/fr/openium/consentium/domain/repository/ConsentiumRepository.kt
View File

@ -1,4 +1,4 @@
package fr.openium.consentium.data.repository
package fr.openium.consentium.domain.repository
import fr.openium.consentium.api.adapter.toPatchConsentPurposeDTO
import fr.openium.consentium.api.adapter.toPurpose

18
consentium/src/main/java/fr/openium/consentium/domain/useCase/GetConsentiumUniqueInstallationIdUseCase.kt Normal file
View File

@ -0,0 +1,18 @@
package fr.openium.consentium.domain.useCase
import fr.openium.consentium.data.local.ConsentiumDataStore
import javax.inject.Inject
interface GetConsentiumUniqueInstallationIdUseCase {
suspend fun invoke(): String
}
class GetConsentiumUniqueInstallationIdUseCaseImpl @Inject internal constructor(
private val consentiumDataStore: ConsentiumDataStore,
) : GetConsentiumUniqueInstallationIdUseCase {
override suspend fun invoke(): String {
return consentiumDataStore.getInstallationUniqueId()
}
}

19
consentium/src/main/java/fr/openium/consentium/domain/useCase/di/ConsentiumUseCaseModule.kt Normal file
View File

@ -0,0 +1,19 @@
package fr.openium.consentium.domain.useCase.di
import dagger.Binds
import dagger.Module
import dagger.hilt.InstallIn
import dagger.hilt.components.SingletonComponent
import fr.openium.consentium.domain.useCase.GetConsentiumUniqueInstallationIdUseCase
import fr.openium.consentium.domain.useCase.GetConsentiumUniqueInstallationIdUseCaseImpl
@Module
@InstallIn(SingletonComponent::class)
interface ConsentiumUseCaseModule {
@Binds
fun bindGetUniqueInstallationIdUseCase(
getUniqueInstallationIdUseCaseImpl: GetConsentiumUniqueInstallationIdUseCaseImpl,
): GetConsentiumUniqueInstallationIdUseCase
}