🚀 2단계 - GitHub(HTTP) (#105)

* app 모듈은 domain 모듈에 의존해야 한다.

* step2 README 작성

* domain 모듈 Model, Repository 생성

* domain - 네트워크 결과 핸들링 로직 생성

* data - Response 생성

* data - Service 생성

* data - 기본 Retrofit, Moshi Converter 설정

* data - RetrofitProvider 생성

* data - 네트워크 에러 핸들링 로직 생성

* data - DefaultRepository 구현

* data - mapper 생성

* data - MockWebServer를 이용한 HTTP 요청 테스트

* data - 구현체 internal

---------

Co-authored-by: jayden.d <[email protected]>

README.md

@@ -1,9 +1,9 @@
 # TODO
 ## Best Practice
-## Step1
+## Step2
 
 ### 이번 미션 TODO
-- 순수 코틀린 모듈인 domain 모듈을 만든다.
-- 순수 코틀린 모듈인 data 모듈을 만든다.
-- data 모듈은 domain 모듈에 의존해야 한다.
-- app 모듈은 domain 모듈에 의존해야 한다.
+- Repository 목록을 가져오는 기능은 data 모듈에 구현되어야 한다.
+- data 모듈의 구현체는 모두 internal class로 선언한다.
+- HTTP 요청을 통해 가져오는 구현체에 대한 테스트 코드를 작성한다.
+- OkHttp MockWebServer 이용

app/build.gradle.kts

@@ -42,7 +42,7 @@ android {
 }
 
 dependencies {
-    implementation(project(":data"))
+    implementation(project(":domain"))
 
     implementation("org.jetbrains.kotlin:kotlin-stdlib:${Version.kotlin}")
     implementation("androidx.core:core-ktx:1.9.0")

data/build.gradle.kts

@@ -9,4 +9,18 @@ java {
 
 dependencies {
     implementation(project(":domain"))
-}
+
+    implementation("com.squareup.okhttp3:okhttp:4.10.0")
+    implementation("com.squareup.okhttp3:logging-interceptor:4.10.0")
+    implementation("com.squareup.retrofit2:retrofit:2.9.0")
+    implementation("com.squareup.retrofit2:converter-moshi:2.9.0")
+    implementation("com.squareup.moshi:moshi-kotlin:1.14.0")
+    implementation("com.squareup.okhttp3:mockwebserver:4.10.0")
+    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3")
+
+    // test
+    testImplementation("junit:junit:4.13.2")
+    testImplementation("com.google.truth:truth:1.1.3")
+    testImplementation("io.mockk:mockk:1.13.7")
+    testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.7.3")
+}

data/src/main/java/camp/nextstep/edu/github/data/Mapper.kt

@@ -0,0 +1,20 @@
+/**
+ * @author Daewon on 01,September,2023
+ *
+ */
+
+package camp.nextstep.edu.github.data
+
+import camp.nextstep.edu.github.data.response.GithubRepositoryResponse
+import camp.nextstep.edu.github.domain.model.GithubRepository
+
+internal fun List<GithubRepositoryResponse>.toDomainModels(): List<GithubRepository> {
+    return this.map { it.toDomainModel() }
+}
+
+internal fun GithubRepositoryResponse.toDomainModel(): GithubRepository {
+    return GithubRepository(
+        fullName = fullName,
+        description = description
+    )
+}

data/src/main/java/camp/nextstep/edu/github/data/di/NetworkProvider.kt

@@ -0,0 +1,13 @@
+package camp.nextstep.edu.github.data.di
+
+import camp.nextstep.edu.github.data.retrofit.BASE_URL
+import camp.nextstep.edu.github.data.retrofit.GithubService
+import camp.nextstep.edu.github.data.retrofit.RetrofitNetwork
+
+internal object NetworkProvider {
+    fun provideGithubService(baseUrl: String = BASE_URL): GithubService {
+        return RetrofitNetwork
+            .create(baseUrl)
+            .create(GithubService::class.java)
+    }
+}

data/src/main/java/camp/nextstep/edu/github/data/network/DefaultNetworkRepository.kt

@@ -0,0 +1,22 @@
+/**
+ * @author Daewon on 31,August,2023
+ *
+ */
+
+package camp.nextstep.edu.github.data.network
+
+import camp.nextstep.edu.github.data.retrofit.GithubService
+import camp.nextstep.edu.github.data.retrofit.networkResult
+import camp.nextstep.edu.github.data.toDomainModels
+import camp.nextstep.edu.github.domain.Result
+import camp.nextstep.edu.github.domain.model.GithubRepository
+import camp.nextstep.edu.github.domain.repository.NetworkRepository
+
+
+internal class DefaultNetworkRepository(
+    private val githubService: GithubService
+) : NetworkRepository {
+    override suspend fun getRepositories(): Result<List<GithubRepository>> =
+        networkResult { githubService.getRepositories().toDomainModels() }
+
+}

data/src/main/java/camp/nextstep/edu/github/data/response/GithubRepositoryResponse.kt

@@ -0,0 +1,10 @@
+package camp.nextstep.edu.github.data.response
+
+import com.squareup.moshi.Json
+
+internal data class GithubRepositoryResponse(
+    @Json(name = "full_name")
+    val fullName: String,
+    @Json(name = "description")
+    val description: String?
+)

data/src/main/java/camp/nextstep/edu/github/data/retrofit/GithubService.kt

@@ -0,0 +1,15 @@
+/**
+ * @author Daewon on 31,August,2023
+ *
+ */
+
+package camp.nextstep.edu.github.data.retrofit
+
+import camp.nextstep.edu.github.data.response.GithubRepositoryResponse
+import retrofit2.http.GET
+
+
+internal interface GithubService {
+    @GET("repositories")
+    suspend fun getRepositories(): List<GithubRepositoryResponse>
+}

data/src/main/java/camp/nextstep/edu/github/data/retrofit/NetworkResult.kt

@@ -0,0 +1,14 @@
+/**
+ * @author Daewon on 22,April,2023
+ *
+ */
+
+package camp.nextstep.edu.github.data.retrofit
+
+import camp.nextstep.edu.github.domain.Result
+
+internal inline fun <T> networkResult(transform: () -> T): Result<T> = try {
+    Result.Success(transform.invoke())
+} catch (e: Exception) {
+    Result.Error(e)
+}

data/src/main/java/camp/nextstep/edu/github/data/retrofit/RetrofitNetwork.kt

@@ -0,0 +1,35 @@
+package camp.nextstep.edu.github.data.retrofit
+
+import com.squareup.moshi.Moshi
+import com.squareup.moshi.kotlin.reflect.KotlinJsonAdapterFactory
+import okhttp3.OkHttpClient
+import okhttp3.logging.HttpLoggingInterceptor
+import retrofit2.Converter
+import retrofit2.Retrofit
+import retrofit2.converter.moshi.MoshiConverterFactory
+
+const val BASE_URL = "https://api.github.com/"
+
+internal object RetrofitNetwork {
+
+    private fun createOkhttpClient(): OkHttpClient {
+        return OkHttpClient.Builder().apply {
+            addInterceptor(HttpLoggingInterceptor())
+        }.build()
+    }
+
+    private fun createJsonAdapterFactory(): Converter.Factory =
+        MoshiConverterFactory.create(
+            Moshi.Builder()
+                .add(KotlinJsonAdapterFactory())
+                .build()
+        )
+
+    fun create(baseUrl: String): Retrofit {
+        return Retrofit.Builder()
+            .client(createOkhttpClient())
+            .baseUrl(baseUrl)
+            .addConverterFactory(createJsonAdapterFactory())
+            .build()
+    }
+}

data/src/test/kotlin/camp/nextstep/edu/github/data/GithubServiceTest.kt

@@ -0,0 +1,64 @@
+/**
+ * @author Daewon on 01,September,2023
+ *
+ */
+
+package camp.nextstep.edu.github.data
+
+import camp.nextstep.edu.github.data.di.NetworkProvider
+import camp.nextstep.edu.github.data.response.GithubRepositoryResponse
+import camp.nextstep.edu.github.data.retrofit.GithubService
+import com.google.common.truth.Truth.assertThat
+import kotlinx.coroutines.test.runTest
+import okhttp3.mockwebserver.MockResponse
+import okhttp3.mockwebserver.MockWebServer
+import org.junit.Before
+import org.junit.Test
+import java.io.File
+
+
+class GithubServiceTest {
+
+    private lateinit var server: MockWebServer
+    private lateinit var githubService: GithubService
+
+    @Before
+    fun setUp() {
+        server = MockWebServer()
+        githubService = NetworkProvider.provideGithubService(server.url("").toString())
+    }
+
+    @Test
+    fun `test_json_요청`() = runTest {
+        // given
+        val response = MockResponse().setBody(File("src/test/resources/repositories.json").readText())
+        server.enqueue(response)
+
+        // when
+        val actual = githubService.getRepositories()
+
+        // then
+        val expected = GithubRepositoryResponse(
+            fullName = "mojombo/grit",
+            description = "**Grit is no longer maintained. Check out libgit2/rugged.** Grit gives you object oriented read/write access to Git repositories via Ruby."
+        )
+        assertThat(actual).contains(expected)
+    }
+
+    @Test
+    fun `test_json_요청2`() = runTest {
+        // given
+        val response = MockResponse().setBody(File("src/test/resources/repositories.json").readText())
+        server.enqueue(response)
+
+        // when
+        val actual = githubService.getRepositories()
+
+        // then
+        val expected = GithubRepositoryResponse(
+            fullName = "jnicklas/uploadcolumn",
+            description = "UploadColumn is no longer maintained, check out CarrierWave for an alternative"
+        )
+        assertThat(actual).contains(expected)
+    }
+}