Step2 - GitHub(HTTP)

README.md

@@ -1,6 +1,16 @@
+# Step2(2023-08-30) #
+    * GitHub(HTTP)
+        * [x] GET, https://api.github.com/repositories
+        * [x] full_name, description 필드만
+        * [x] Repository 목록을 가져오는 기능은 data 모듈에 구현되어야 한다.
+        * [x] data 모듈의 구현체는 모두 internal class로 선언한다.
+        * [x]HTTP 요청을 통해 가져오는 구현체에 대한 테스트 코드를 작성한다.
+
 # Step1(2023-08-29) #
-    * [x] 순수 코틀린 모듈인 domain 모듈을 만든다.
-    * [x] 순수 코틀린 모듈인 data 모듈을 만든다.
-    * [x] data 모듈은 domain 모듈에 의존해야 한다.
-    * [x] app 모듈은 domain 모듈에 의존해야 한다.
-
+    * GitHub(모듈 분리)
+        * [x] 순수 코틀린 모듈인 domain 모듈을 만든다.
+        * [x] 순수 코틀린 모듈인 data 모듈을 만든다.
+        * [x] data 모듈은 domain 모듈에 의존해야 한다.
+        * [x] app 모듈은 domain 모듈에 의존해야 한다.
+    * 1차 피드백
+        * [x] Android Studio linebreak 설정 추가

buildSrc/src/main/kotlin/Configs.kt

@@ -4,4 +4,11 @@ object Version {
     const val compileSdk = 33
     const val minSdk = 26
     const val targetSdk = 33
+
+    const val retrofit = "2.9.0"
+    const val okHttp = "4.9.3"
+    const val coroutineTest = "1.6.2"
+
+    const val junit = "5.8.2"
+    const val truth = "1.1.3"
 }

data/build.gradle.kts

@@ -9,4 +9,21 @@ java {
 
 dependencies {
     implementation(project(":domain"))
-}
+
+    // retrofit
+    implementation("com.squareup.retrofit2:retrofit:${Version.retrofit}")
+    implementation("com.squareup.retrofit2:converter-gson:${Version.retrofit}")
+    implementation("com.squareup.okhttp3:okhttp:${Version.okHttp}")
+    implementation("com.squareup.okhttp3:logging-interceptor:${Version.okHttp}")
+    implementation("com.squareup.okhttp3:mockwebserver:${Version.okHttp}")
+
+    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:${Version.coroutineTest}")
+    testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:${Version.coroutineTest}")
+
+    testImplementation("org.junit.jupiter:junit-jupiter:${Version.junit}")
+    testImplementation("com.google.truth:truth:${Version.truth}")
+}
+
+tasks.test {
+    useJUnitPlatform()
+}

data/src/main/java/com/nextstep/edu/data/ApiClient.kt

@@ -0,0 +1,5 @@
+package com.nextstep.edu.data
+
+internal object ApiClient {
+    const val BASE_URL = "https://api.github.com/"
+}

data/src/main/java/com/nextstep/edu/data/GithubService.kt

@@ -0,0 +1,11 @@
+package com.nextstep.edu.data
+
+import com.nextstep.edu.data.model.RepositoryResponse
+import retrofit2.http.GET
+
+internal interface GithubService {
+
+    // 유저 목록 가져오기
+    @GET("repositories")
+    suspend fun getRepositories(): List<RepositoryResponse>
+}

data/src/main/java/com/nextstep/edu/data/di/NetworkModule.kt

@@ -0,0 +1,20 @@
+package com.nextstep.edu.data.di
+
+import com.nextstep.edu.data.ApiClient
+import com.nextstep.edu.data.GithubService
+import okhttp3.OkHttpClient
+import retrofit2.Retrofit
+import retrofit2.converter.gson.GsonConverterFactory
+
+internal object NetworkModule {
+
+    fun provideRetrofit(): Retrofit = Retrofit.Builder()
+        .baseUrl(ApiClient.BASE_URL)
+        .client(provideOkHttpClient())
+        .addConverterFactory(GsonConverterFactory.create())
+        .build()
+
+    private fun provideOkHttpClient(): OkHttpClient = OkHttpClient.Builder().build()
+
+    fun provideGithubService(retrofit: Retrofit): GithubService = retrofit.create(GithubService::class.java)
+}

data/src/main/java/com/nextstep/edu/data/model/RepositoryResponse.kt

@@ -0,0 +1,16 @@
+package com.nextstep.edu.data.model
+
+import com.google.gson.annotations.SerializedName
+import com.nextstep.edu.domain.model.Repository
+
+internal data class RepositoryResponse(
+    @SerializedName("full_name")
+    val fullName: String,
+
+    @SerializedName("description")
+    val description: String
+) {
+    fun toDomain(): Repository {
+        return Repository(fullName = this.fullName, description = this.description)
+    }
+}

data/src/main/java/com/nextstep/edu/data/repository/RemoteRepositoryImpl.kt

@@ -0,0 +1,14 @@
+package com.nextstep.edu.data.repository
+
+import com.nextstep.edu.data.GithubService
+import com.nextstep.edu.data.model.RepositoryResponse
+import com.nextstep.edu.domain.repository.RemoteRepository
+import com.nextstep.edu.domain.model.Repository
+
+internal class RemoteRepositoryImpl(
+    private val githubService: GithubService
+): RemoteRepository {
+    override suspend fun getRepositories(): List<Repository> {
+        return githubService.getRepositories().map(RepositoryResponse::toDomain)
+    }
+}

data/src/test/java/com.nextstep.edu.data/GithubServiceTest.kt

@@ -0,0 +1,71 @@
+package com.nextstep.edu.data
+
+import com.google.common.truth.Truth.assertThat
+import com.nextstep.edu.data.model.RepositoryResponse
+import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.test.StandardTestDispatcher
+import kotlinx.coroutines.test.TestScope
+import kotlinx.coroutines.test.runTest
+import okhttp3.mockwebserver.MockResponse
+import okhttp3.mockwebserver.MockWebServer
+import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.Test
+import retrofit2.Retrofit
+import retrofit2.converter.gson.GsonConverterFactory
+import java.io.File
+
+@ExperimentalCoroutinesApi
+class GithubServiceTest {
+
+    private val testDispatcher = StandardTestDispatcher()
+    private val testScope = TestScope(testDispatcher)
+
+    private lateinit var server: MockWebServer
+    private lateinit var service: GithubService
+
+    @BeforeEach
+    fun setup() {
+        server = MockWebServer()
+        service = Retrofit.Builder()
+            .addConverterFactory(GsonConverterFactory.create())
+            .baseUrl(server.url(""))
+            .build()
+            .create(GithubService::class.java)
+    }
+
+    @Test
+    fun `getRepositories 호출`() = testScope.runTest {
+        // given : githubRepositories.json 파일이 주어졌을 때
+        val response = MockResponse()
+            .setBody(File("src/test/resources/githubRepositories.json").readText())
+        server.enqueue(response)
+
+        // when : getRepositories() 를 요청 하면
+        val actual = service.getRepositories()
+
+        // then : 결과의 첫번째의 full_name은 mojombo/grit 이다.
+        val expected = RepositoryResponse(
+            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[0]).isEqualTo(expected)
+    }
+
+    @Test
+    fun `getRepositories 호출2`() = testScope.runTest {
+        // given : githubRepositories.json 파일이 주어졌을 때
+        val response = MockResponse()
+            .setBody(File("src/test/resources/githubRepositories.json").readText())
+        server.enqueue(response)
+
+        // when : getRepositories() 를 요청 하면
+        val actual = service.getRepositories()
+
+        // then : 결과의 두번째의 full_name은 wycats/merb-core 이다.
+        val expected = RepositoryResponse(
+            fullName = "wycats/merb-core",
+            description = "Merb Core: All you need. None you don't."
+        )
+        assertThat(actual[1]).isEqualTo(expected)
+    }
+}