Step2 - GitHub(HTTP)

README.md

@@ -0,0 +1,20 @@
+# android-github
+
+## 1 단계 - GitHub(모듈 분리)
+### 프로그래밍 요구 사항
+- 순수 코틀린 모듈인 domain 모듈을 만든다.
+- 순수 코틀린 모듈인 data 모듈을 만든다.
+- data 모듈은 domain 모듈에 의존해야 한다.
+- app 모듈은 domain 모듈에 의존해야 한다.
+
+## 2단계 - GitHub(HTTP)
+###기능 요구사항
+- GitHub Repository 목록을 가져올 수 있어야 한다.
+- GET, https://api.github.com/repositories
+- full_name, description 필드만
+
+###프로그래밍 요구사항
+- Repository 목록을 가져오는 기능은 data 모듈에 구현되어야 한다.
+- data 모듈의 구현체는 모두 internal class로 선언한다.
+- HTTP 요청을 통해 가져오는 구현체에 대한 테스트 코드를 작성한다.
+- OkHttp MockWebServer 이용

app/build.gradle.kts

@@ -1,5 +1,3 @@
-@file:Suppress("UnstableApiUsage")
-
 plugins {
     id("com.android.application")
     id("kotlin-android")
@@ -10,7 +8,7 @@ android {
     compileSdk = Version.compileSdk
 
     defaultConfig {
-        applicationId = "edu.nextstep.camp.calculator"
+        applicationId = "camp.nextstep.edu.github"
         minSdk = Version.minSdk
         targetSdk = Version.targetSdk
         versionCode = 1
@@ -42,17 +40,26 @@ android {
 }
 
 dependencies {
-    api(project(":github-domain"))
+    implementation(project(":github-data"))
+    implementation(project(":github-domain"))
 
     implementation("org.jetbrains.kotlin:kotlin-stdlib:${Version.kotlin}")
-    implementation("androidx.core:core-ktx:1.9.0")
-    implementation("androidx.appcompat:appcompat:1.6.0")
-    implementation("com.google.android.material:material:1.7.0")
+    implementation("androidx.core:core-ktx:1.10.1")
+    implementation("androidx.appcompat:appcompat:1.6.1")
+    implementation("com.google.android.material:material:1.9.0")
     implementation("androidx.constraintlayout:constraintlayout:2.1.4")
-    implementation("androidx.fragment:fragment-ktx:1.5.5")
+    implementation("androidx.fragment:fragment-ktx:1.6.1")
+    implementation("com.squareup.retrofit2:retrofit:2.9.0")
+    implementation ("com.squareup.retrofit2:converter-gson:2.9.0")
+    implementation ("com.google.code.gson:gson:2.10.1")
+    implementation("androidx.room:room-runtime:2.5.2")
+    annotationProcessor("androidx.room:room-compiler:2.5.2")
 
     testImplementation("junit:junit:4.13.2")
     testImplementation("com.google.truth:truth:1.1.3")
+    testImplementation ("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.6.4")
+    implementation("com.squareup.okhttp3:mockwebserver:4.11.0")
     androidTestImplementation("androidx.test.ext:junit:1.1.5")
     androidTestImplementation("androidx.test.espresso:espresso-core:3.5.1")
 }
+

app/src/main/AndroidManifest.xml

@@ -2,6 +2,8 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
     package="camp.nextstep.edu.github">
 
+    <uses-permission android:name="android.permission.INTERNET" />
+
     <application
         android:allowBackup="true"
         android:icon="@mipmap/ic_launcher"

app/src/main/java/camp/nextstep/edu/github/GitHubViewModel.kt

@@ -0,0 +1,8 @@
+package camp.nextstep.edu.github
+
+import androidx.lifecycle.ViewModel
+import com.example.githubdomain.GitHubRepository
+
+class GitHubViewModel : ViewModel() {
+
+}

app/src/main/java/camp/nextstep/edu/github/MainActivity.kt

@@ -2,10 +2,30 @@ package camp.nextstep.edu.github
 
 import androidx.appcompat.app.AppCompatActivity
 import android.os.Bundle
+import androidx.activity.viewModels
+import camp.nextstep.edu.github.databinding.ActivityMainBinding
 
 class MainActivity : AppCompatActivity() {
+
+    private lateinit var binding: ActivityMainBinding
+    private val viewModel: GitHubViewModel by viewModels()
+
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         setContentView(R.layout.activity_main)
+
+        initBinding()
+        initViewModel()
+
+        setContentView(binding.root)
+    }
+
+    private fun initViewModel() {
+        binding.viewModel = viewModel
+    }
+
+    private fun initBinding() {
+        binding = ActivityMainBinding.inflate(layoutInflater)
+        binding.lifecycleOwner = this
     }
-}
+}

app/src/main/res/layout/activity_main.xml

@@ -1,21 +1,26 @@
 <?xml version="1.0" encoding="utf-8"?>
-<androidx.constraintlayout.widget.ConstraintLayout
-    xmlns:android="http://schemas.android.com/apk/res/android"
-    xmlns:app="http://schemas.android.com/apk/res-auto"
-    xmlns:tools="http://schemas.android.com/tools"
-    android:layout_width="match_parent"
-    android:layout_height="match_parent"
-    tools:context=".MainActivity"
-    >
+<layout>
+    <data>
+        <variable
+            name="viewModel"
+            type="camp.nextstep.edu.github.GitHubViewModel" />
+    </data>
 
-    <TextView
-        android:layout_width="wrap_content"
-        android:layout_height="wrap_content"
-        android:text="Hello World!"
-        app:layout_constraintBottom_toBottomOf="parent"
-        app:layout_constraintLeft_toLeftOf="parent"
-        app:layout_constraintRight_toRightOf="parent"
-        app:layout_constraintTop_toTopOf="parent"
-        />
+    <androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
+        xmlns:app="http://schemas.android.com/apk/res-auto"
+        xmlns:tools="http://schemas.android.com/tools"
+        android:layout_width="match_parent"
+        android:layout_height="match_parent"
+        tools:context=".MainActivity">
 
-</androidx.constraintlayout.widget.ConstraintLayout>
+        <Button
+            android:layout_width="wrap_content"
+            android:layout_height="wrap_content"
+            android:text="github/repositories 저장"
+            app:layout_constraintBottom_toBottomOf="parent"
+            app:layout_constraintLeft_toLeftOf="parent"
+            app:layout_constraintRight_toRightOf="parent"
+            app:layout_constraintTop_toTopOf="parent"/>
+
+    </androidx.constraintlayout.widget.ConstraintLayout>
+</layout>

github-data/build.gradle.kts

@@ -1,13 +1,60 @@
 plugins {
-    id("java-library")
-    id("org.jetbrains.kotlin.jvm")
+    id("com.android.library")
+    id("org.jetbrains.kotlin.android")
+    id("kotlin-kapt")
 }
 
-java {
-    sourceCompatibility = JavaVersion.VERSION_1_8
-    targetCompatibility = JavaVersion.VERSION_1_8
+android {
+    namespace = "camp.nextstep.edu.github.github_data"
+    compileSdk = Version.compileSdk
+
+    defaultConfig {
+        minSdk = Version.minSdk
+
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+        consumerProguardFiles("consumer-rules.pro")
+    }
+
+    buildTypes {
+        release {
+            isMinifyEnabled = false
+            proguardFiles(
+                getDefaultProguardFile("proguard-android-optimize.txt"),
+                "proguard-rules.pro"
+            )
+        }
+    }
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
+    }
+    kotlinOptions {
+        jvmTarget = "1.8"
+    }
+
+    testOptions {
+        unitTests {
+            isIncludeAndroidResources = true
+        }
+    }
 }
 
-dependencies {
-    api(project(":github-domain"))
+dependencies{
+    implementation(project(":github-domain"))
+
+    implementation("com.squareup.retrofit2:retrofit:2.9.0")
+    implementation ("com.squareup.retrofit2:converter-gson:2.9.0")
+    implementation ("com.google.code.gson:gson:2.10.1")
+    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.4")
+    implementation("androidx.room:room-runtime:2.5.2")
+    implementation("com.squareup.okhttp3:mockwebserver:4.11.0")
+    implementation("androidx.test:core-ktx:1.5.0")
+
+    kapt ("androidx.room:room-compiler:2.5.2")
+
+    testImplementation("junit:junit:4.13.2")
+    testImplementation ("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.6.4")
+    testImplementation("com.google.truth:truth:1.1.3")
+    testImplementation ("org.robolectric:robolectric:4.9")
+
 }

github-data/src/main/java/com/example/github/GitHubApi.kt

@@ -0,0 +1,10 @@
+package com.example.github
+
+import com.example.github.data.repository.remote.data.RemoteGithubData
+import retrofit2.Response
+import retrofit2.http.GET
+
+interface GitHubApi {
+    @GET("/repositories")
+    suspend fun getGitHubRepo(): Response<List<RemoteGithubData>>
+}

github-data/src/main/java/com/example/github/GitHubService.kt

@@ -0,0 +1,16 @@
+package com.example.github
+
+import retrofit2.Retrofit
+import retrofit2.converter.gson.GsonConverterFactory
+
+internal object GitHubService {
+    private val BASE_URL = "https://api.github.com"
+
+    fun getGitHubService(): GitHubApi {
+        return Retrofit.Builder()
+            .baseUrl(BASE_URL)
+            .addConverterFactory(GsonConverterFactory.create())
+            .build()
+            .create(GitHubApi::class.java)
+    }
+}

github-data/src/main/java/com/example/github/data/mapper/Mapper.kt

@@ -0,0 +1,35 @@
+package com.example.github.data.mapper
+
+import com.example.github.data.repository.remote.data.RemoteGithubData
+import com.example.github.data.room.GithubRepoEntity
+import com.example.githubdomain.GithubRepoData
+
+fun  List<GithubRepoEntity>.githubRepoEntityToGithubRepoData(): List<GithubRepoData> {
+    return this.toList().map {
+        GithubRepoData(
+            id = it.id,
+            fullName = it.fullName,
+            description = it.description ?: ""
+        )
+    }
+}
+
+fun List<RemoteGithubData>.remoteGithubDataToGithubRepoData(): List<GithubRepoData> {
+    return this.toList().map {
+        GithubRepoData(
+            id = it.id,
+            fullName = it.fullName,
+            description = it.description
+        )
+    }
+}
+
+fun List<GithubRepoData>.githubRepoDataToGithubRepoEntity(): List<GithubRepoEntity> {
+    return this.toList().map {
+        GithubRepoEntity(
+            id = it.id,
+            fullName = it.fullName,
+            description = it.description
+        )
+    }
+}

github-data/src/main/java/com/example/github/data/repository/GithubRepositoryImpl.kt

@@ -0,0 +1,32 @@
+package com.example.github.data.repository
+import com.example.github.data.mapper.githubRepoEntityToGithubRepoData
+import com.example.github.data.mapper.remoteGithubDataToGithubRepoData
+import com.example.github.data.repository.local.LocalGithubDataSource
+import com.example.github.data.repository.remote.RemoteGithubDataSource
+import com.example.githubdomain.GitHubRepository
+import com.example.githubdomain.GithubRepoData
+
+internal class GithubRepositoryImpl(
+    private val localGithubDataSource: LocalGithubDataSource,
+    private val remoteGithubDataSource: RemoteGithubDataSource
+): GitHubRepository {
+
+    override suspend fun getGitHubRepoData(): List<GithubRepoData> {
+        val localData = localGithubDataSource.getGitHubRepo()
+        return if(localData.isNullOrEmpty()) {
+            try {
+                remoteGithubDataSource.getGitHubRepo().remoteGithubDataToGithubRepoData().also {
+                    localGithubDataSource.insertGitHubRepo(it)
+                }
+            } catch (e: Exception) {
+                e.printStackTrace()
+                emptyList()
+            }
+
+        } else {
+            localData.githubRepoEntityToGithubRepoData()
+        }
+    }
+
+    suspend fun isEmptyLocalData() = localGithubDataSource.getGitHubRepo().isNullOrEmpty()
+}

github-data/src/main/java/com/example/github/data/repository/local/FakeLocalGithubDataSourceImpl.kt

@@ -0,0 +1,14 @@
+package com.example.github.data.repository.local
+
+import com.example.github.data.mapper.githubRepoDataToGithubRepoEntity
+import com.example.github.data.room.GithubRepoEntity
+import com.example.githubdomain.GithubRepoData
+
+internal class FakeLocalGithubDataSourceImpl: LocalGithubDataSource {
+    private val gitHubRepoEntityList = mutableListOf<GithubRepoEntity>()
+    override suspend fun getGitHubRepo() = gitHubRepoEntityList
+
+    override fun insertGitHubRepo(gitHubRepoDataList: List<GithubRepoData>) {
+        gitHubRepoEntityList.addAll(gitHubRepoDataList.githubRepoDataToGithubRepoEntity())
+    }
+}

github-data/src/main/java/com/example/github/data/repository/local/LocalGithubDataSource.kt

@@ -0,0 +1,10 @@
+package com.example.github.data.repository.local
+
+import com.example.github.data.room.GithubRepoEntity
+import com.example.githubdomain.GithubRepoData
+
+interface LocalGithubDataSource {
+    suspend fun getGitHubRepo(): List<GithubRepoEntity>
+
+    fun insertGitHubRepo(gitHubRepoDataList: List<GithubRepoData>)
+}

github-data/src/main/java/com/example/github/data/repository/local/LocalGithubDataSourceImpl.kt

@@ -0,0 +1,21 @@
+package com.example.github.data.repository.local
+
+import com.example.github.data.mapper.githubRepoDataToGithubRepoEntity
+import com.example.github.data.room.GithubRepoDao
+import com.example.github.data.room.GithubRepoEntity
+import com.example.githubdomain.GithubRepoData
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.async
+
+internal class LocalGithubDataSourceImpl(private val githubDao: GithubRepoDao): LocalGithubDataSource {
+    override suspend fun getGitHubRepo(): List<GithubRepoEntity> {
+        return CoroutineScope(Dispatchers.IO).async {
+            githubDao.getGitHubRepo()
+        }.await()
+    }
+
+    override fun insertGitHubRepo(gitHubRepoDataList: List<GithubRepoData>) {
+        githubDao.insertGithubRepoEntityList(gitHubRepoDataList.githubRepoDataToGithubRepoEntity())
+    }
+}

github-data/src/main/java/com/example/github/data/repository/remote/RemoteGithubDataSource.kt

@@ -0,0 +1,7 @@
+package com.example.github.data.repository.remote
+
+import com.example.github.data.repository.remote.data.RemoteGithubData
+
+interface RemoteGithubDataSource {
+    suspend fun getGitHubRepo(): List<RemoteGithubData>
+}