BIT-654: Generator SDK interface and repository implementation (#233)

app/src/main/java/com/x8bit/bitwarden/data/generator/datasource/sdk/GeneratorSdkSource.kt

@@ -0,0 +1,14 @@
+package com.x8bit.bitwarden.data.generator.datasource.sdk
+
+import com.bitwarden.core.PasswordGeneratorRequest
+
+/**
+ * Source of password generation functionality from the Bitwarden SDK.
+ */
+interface GeneratorSdkSource {
+
+    /**
+     * Generates a password returning a [String] wrapped in a [Result].
+     */
+    suspend fun generatePassword(request: PasswordGeneratorRequest): Result<String>
+}

app/src/main/java/com/x8bit/bitwarden/data/generator/datasource/sdk/GeneratorSdkSourceImpl.kt

@@ -0,0 +1,20 @@
+package com.x8bit.bitwarden.data.generator.datasource.sdk
+
+import com.bitwarden.core.PasswordGeneratorRequest
+import com.bitwarden.sdk.ClientGenerators
+
+/**
+ * Implementation of [GeneratorSdkSource] that delegates password generation.
+ *
+ * @property clientGenerator An instance of [ClientGenerators] provided by the Bitwarden SDK.
+ */
+class GeneratorSdkSourceImpl(
+    private val clientGenerator: ClientGenerators,
+) : GeneratorSdkSource {
+
+    override suspend fun generatePassword(
+        request: PasswordGeneratorRequest,
+    ): Result<String> = runCatching {
+        clientGenerator.password(request)
+    }
+}

app/src/main/java/com/x8bit/bitwarden/data/generator/datasource/sdk/di/GeneratorSdkModule.kt

@@ -0,0 +1,24 @@
+package com.x8bit.bitwarden.data.generator.datasource.sdk.di
+
+import com.bitwarden.sdk.Client
+import com.x8bit.bitwarden.data.generator.datasource.sdk.GeneratorSdkSource
+import com.x8bit.bitwarden.data.generator.datasource.sdk.GeneratorSdkSourceImpl
+import dagger.Module
+import dagger.Provides
+import dagger.hilt.InstallIn
+import dagger.hilt.components.SingletonComponent
+import javax.inject.Singleton
+
+/**
+ * Provides SDK-related dependencies for the password generation package.
+ */
+@Module
+@InstallIn(SingletonComponent::class)
+object GeneratorSdkModule {
+
+    @Provides
+    @Singleton
+    fun provideGeneratorSdkSource(
+        client: Client,
+    ): GeneratorSdkSource = GeneratorSdkSourceImpl(clientGenerator = client.generators())
+}

app/src/main/java/com/x8bit/bitwarden/data/generator/repository/GeneratorRepository.kt

@@ -0,0 +1,17 @@
+package com.x8bit.bitwarden.data.generator.repository
+
+import com.bitwarden.core.PasswordGeneratorRequest
+import com.x8bit.bitwarden.data.generator.repository.model.GeneratedPasswordResult
+
+/**
+ * Responsible for managing generator data.
+ */
+interface GeneratorRepository {
+
+    /**
+     * Attempt to generate a password.
+     */
+    suspend fun generatePassword(
+        passwordGeneratorRequest: PasswordGeneratorRequest,
+    ): GeneratedPasswordResult
+}

app/src/main/java/com/x8bit/bitwarden/data/generator/repository/GeneratorRepositoryImpl.kt

@@ -0,0 +1,25 @@
+package com.x8bit.bitwarden.data.generator.repository
+
+import com.bitwarden.core.PasswordGeneratorRequest
+import com.x8bit.bitwarden.data.generator.datasource.sdk.GeneratorSdkSource
+import com.x8bit.bitwarden.data.generator.repository.model.GeneratedPasswordResult
+import javax.inject.Singleton
+
+/**
+ * Default implementation of [GeneratorRepository].
+ */
+@Singleton
+class GeneratorRepositoryImpl constructor(
+    private val generatorSdkSource: GeneratorSdkSource,
+) : GeneratorRepository {
+
+    override suspend fun generatePassword(
+        passwordGeneratorRequest: PasswordGeneratorRequest,
+    ): GeneratedPasswordResult =
+        generatorSdkSource
+            .generatePassword(passwordGeneratorRequest)
+            .fold(
+                onSuccess = { GeneratedPasswordResult.Success(it) },
+                onFailure = { GeneratedPasswordResult.InvalidRequest },
+            )
+}

app/src/main/java/com/x8bit/bitwarden/data/generator/repository/di/GeneratorRepositoryModule.kt

@@ -0,0 +1,24 @@
+package com.x8bit.bitwarden.data.generator.repository.di
+
+import com.x8bit.bitwarden.data.generator.datasource.sdk.GeneratorSdkSource
+import com.x8bit.bitwarden.data.generator.repository.GeneratorRepository
+import com.x8bit.bitwarden.data.generator.repository.GeneratorRepositoryImpl
+import dagger.Module
+import dagger.Provides
+import dagger.hilt.InstallIn
+import dagger.hilt.components.SingletonComponent
+import javax.inject.Singleton
+
+/**
+ * Provides repositories in the generator package.
+ */
+@Module
+@InstallIn(SingletonComponent::class)
+object GeneratorRepositoryModule {
+
+    @Provides
+    @Singleton
+    fun provideGeneratorRepository(
+        generatorSdkSource: GeneratorSdkSource,
+    ): GeneratorRepository = GeneratorRepositoryImpl(generatorSdkSource)
+}

app/src/main/java/com/x8bit/bitwarden/data/generator/repository/model/GeneratedPasswordResult.kt

@@ -0,0 +1,17 @@
+package com.x8bit.bitwarden.data.generator.repository.model
+
+/**
+ * Represents the outcome of a generator operation.
+ */
+sealed class GeneratedPasswordResult {
+
+    /**
+     * Operation succeeded with a value.
+     */
+    data class Success(val generatedString: String) : GeneratedPasswordResult()
+
+    /**
+     * There was an error during the operation.
+     */
+    data object InvalidRequest : GeneratedPasswordResult()
+}