Merge remote-tracking branch 'origin/develop' into feature/refactor-data

# Conflicts:
#	app/src/main/java/com/runnect/runnect/di/RetrofitModule.kt

Author: sxunea

README.md

@@ -1,87 +1,75 @@
- # <b>🏃🏻 Runnect-Android Repository 🏃🏼</b>
-
-![212252027-210bd23c-e363-4e6f-8e15-1a88bf237bc2 (1)](https://user-images.githubusercontent.com/89737271/216818552-9f9c5e62-b6cb-4128-ab6e-99600493b9a8.png)
-
-<br>
+ # 🏃🏼‍♀️ Runnect-Android 🏃🏻‍♂️
+ 
+<img width="800" src="https://github.com/Runnect/Runnect-Android/assets/68090939/d1d3d952-5fd7-4991-9f5b-eed648128930"/>
 
+## 💁🏻‍♀️ Introduction
 
+Runnect는 Run과 Connect의 합성어로 “능동적인 러닝 문화”와 “러너 간의 네트워킹”으로 러닝에 쉽게 다가가는 세상을 꿈꿉니다. 
 
-## Contributors 💛
-| [@Larry7939](https://github.com/Larry7939) | [@unam98](https://github.com/unam98) |
-| :---: | :---: |
-|<img width="400" src="https://github.com/Runnect/Runnect-Android/assets/89737271/29aa0044-0653-4573-9957-ddd46090a7fc.jpg">|<img width="400" src="https://github.com/Runnect/Runnect-Android/assets/89737271/58992dce-d7b6-4e33-9d9c-279d5a3a0ef1.jpg">|
-|**코스 발견 & 마이페이지**|**코스 그리기 & 보관함**|
+코스 그리기와 자유로운 공유를 통해 러너 간의 Connect를 강화하고, 편리한 러닝을 도와줍니다.
 
-<br>
+직접 코스를 그려 목표를 설정하고, 다른 러너와 코스를 공유해 보세요! 꾸준한 성취감과 함께 어느새 일상에 자리 잡은 러닝을 발견할 수 있을 거예요! 
 
-<h2 id="0.5">
-    <b>💁 Service introduce</b>
-</h2>
+## 🎉 Download 
 
-### Runnect는 지도에 직접 러닝 코스를 그리고 공유하며 서로를 연결해주고 함께 달릴 수 있는 서비스입니다. 
+<a href="https://play.google.com/store/apps/details?id=com.runnect.runnect&hl=ko"><img width="40%" src="https://play.google.com/intl/ko/badges/static/images/badges/ko_badge_web_generic.png"/></a>
 
--   검색을 통해 출발지를 설정하고 지도에 원하는 러닝 코스를 직접 그릴 수 있음
--   생성된 코스는 아카이빙되며 다른 유저들과 공유하거나 나중에 해당 코스를 다시 달려볼 수 있음
--   다른 유저들이 올린 러닝 코스를 스크랩할 수 있으며 본인의 러닝 코스로 설정하여 따라 달려볼 수 있음  
--   본인이 선택한 러닝 코스에 대해 거리/이동시간/평균페이스 정보를 제공받을 수 있음
--   미션 달성 여부에 따라 스탬프를 모아볼 수 있음
+## ✨ Features
 
-<br>
+### 코스 그리기
 
-<h2 id="2">🚀 Technology</h2>
+달리기 전, 오늘 뛰게 될 코스를 직접 그려보세요. 내가 나아갈 길을 개척하는 능동적인 러너로 거듭날 수 있습니다.
 
-### 🛠 Tech Stack
+<img width="720" src="https://github.com/Runnect/Runnect-Android/assets/68090939/8ab5b2f9-246c-4aeb-90c8-6027ddd902da"/> 
 
-`Kotlin`, `JetPack`, `DataBinding`, `ViewModel`, `AAC`, `LiveData`, `OkHttp`, `Hilt`, `Glide`, `Timber`, `Coroutine`, `CustomView`
+### 코스 아카이빙 
 
-### ⚙️ Architecture
+내가 여태까지 그린 코스를 다시 확인하고, 스크랩 했던 공유 코스를 관리할 수 있어요. 마이페이지에서 나의 러닝 기록도 확인할 수 있어요. 
 
-`MVVM`
+<img width="720" src="https://github.com/Runnect/Runnect-Android/assets/68090939/33d01e6e-e748-4396-990a-e0feb23a3eb6"/> 
 
-<br>
+### 코스 발견  
 
-<h2 id="3">🏙 Result</h2>
+다른 러너는 어떤 코스로 달리고 있을까요? 오늘은 새롭게 발견한 코스를 스크랩하여 달려 보세요.
 
-### 🎉 [Play Store Download](https://play.google.com/store/apps/details?id=com.runnect.runnect&hl=ko) (v.1.0.1)
+<img width="720" src="https://github.com/Runnect/Runnect-Android/assets/68090939/8f7c15ef-958f-401b-920c-cd750f4339c4"/>
 
-<br>
+### 코스 공유 
 
-<p float="left">  
-<img width="40%" src="https://github.com/Runnect/Runnect-Android/assets/89737271/7e268e3b-ef70-410f-9331-aa50874da7ab.jpg">
+코스를 보다 빠르고 간편하게 공유하세요! 
 
-<img width="40%" src="https://github.com/Runnect/Runnect-Android/assets/89737271/7cb3751a-b7f0-4c73-953c-514cad2141aa.jpg">
-</p>
-<p float="left">  
-<img width="40%" src="https://github.com/Runnect/Runnect-Android/assets/89737271/f2f683bc-c9d2-4290-9e03-060f2b27b0e3.jpg">
+<img width="720" src="https://github.com/Runnect/Runnect-Android/assets/68090939/c05cabf1-7883-4aff-af0f-a296ceb00c80"/>
 
-<img width="40%" src="https://github.com/Runnect/Runnect-Android/assets/89737271/5c8a226a-00d8-4d99-87af-17e2f238600b.jpg">
-</p>
-<p float="left">  
-<img width="40%" src="https://github.com/Runnect/Runnect-Android/assets/89737271/d209791c-9c17-471c-b141-0f086ed6517f.jpg">
+## 🛠 Tech Stack
 
-<img width="40%" src="https://github.com/Runnect/Runnect-Android/assets/89737271/f1c6bc3b-0d45-4f1f-9f8c-74b5fdc8e2ef.jpg">
-</p>
+| 구분                    | 기술 스택                                                               |
+| ----------------------- | ----------------------------------------------------------------------- |
+| Architecture            | MVVM                                                                    |
+| Design Pattern          | Observer Pattern, Repository Pattern                                    |
+| JetPack Components      | LifeCycle, ViewModel, LiveData, DataBinding, EncryptedSharedPreferences |
+| Dependency Injection    | Hilt                                                                    |
+| Network                 | Retrofit, OkHttp, kotlinx.serialization                                 |
+| Asynchronous Processing | Coroutine                                                               |
+| Third Party Library     | Google Login, Kakao Login, Naver Map, TMAP, Glide, Coil, Timber         |
+| Branch Strategy         | Git Flow                                                                |
+| CI                      | GitHub Actions                                                          |
+| Data Analytics          | Firebase Analytics                                                      |
+| Communication Tool      | Notion, Slack, Figma, Postman                                           |
 
-<p float="left">  
-<img width="40%" src="https://github.com/Runnect/Runnect-Android/assets/89737271/7754f0d4-bad7-4399-a3ad-e62ea22f77f6.jpg">
 
-<img width="40%" src="https://github.com/Runnect/Runnect-Android/assets/89737271/0ccbb55d-e871-4c20-891f-a2a5f6bcac49.jpg">
-</p>
+## 🌱 Contributors
 
-<p float="left">  
-<img width="40%" src="https://github.com/Runnect/Runnect-Android/assets/89737271/71ef4384-0632-46ae-b765-45fe4c7fc730.jpg">
+### Current
 
-<img width="40%" src="https://github.com/Runnect/Runnect-Android/assets/89737271/dc7f279b-4a6b-4e75-b3eb-979d1d7ae82e.jpg">
-</p>
+| [김우남](https://github.com/unam98) | [이하은](https://github.com/leeeha) | [백혜선](https://github.com/sxunea) | [김동현](https://github.com/Donghyeon0915) |
+| :---: | :---: | :---: | :---: |
+|<img width="150" src="https://github.com/Runnect/Runnect-Android/assets/68090939/e0fd9897-485e-41ad-b7ee-8be0573942ec">|<img width="150" src="https://github.com/Runnect/Runnect-Android/assets/68090939/9f7d8751-503c-4af6-a67c-b6e42b371e25">|<img width="150" src="https://github.com/team-winey/Winey-AOS/assets/68090939/7eb22b00-ef67-4ad0-9ae9-1bc5e579524b">|<img width="150" src="https://github.com/Runnect/Runnect-Android/assets/68090939/d9e40f14-5184-4739-82cd-0afce65553c7">|
+|코스 그리기, 보관함, <br> 업로드 한 코스 공유|코스 발견, 코스 상세, <br> 그린 코스 공유, 러닝 기록|유저 프로필 조회, <br> 위치 권한 설정, <br> 이벤트 태깅|보관함, 이벤트 태깅|
+| 2022.12 ~ ing | 2023.09 ~ ing | 2023.11 ~ ing | 2023.11 ~ ing |
 
-<p float="left">  
-<img width="40%" src="https://github.com/Runnect/Runnect-Android/assets/89737271/861ad768-570e-43c1-8cab-cd26a46b13ab.jpg">
+### Past 
 
-<img width="40%" src="https://github.com/Runnect/Runnect-Android/assets/89737271/e8566a6e-0257-412b-b770-0e37e1edd1b1.jpg">
-</p>
+| 이름 | 역할 | 활동 기간 | 작업물 |
+| --- | --- | --- | :----------------------: |
+| [박지훈](https://github.com/Larry7939) | 코스발견, 마이페이지 | 2022.12 ~ 2023.08 | [branch(23.08.27)](https://github.com/Runnect/Runnect-Android/tree/fix/215-%EC%BD%94%EC%8A%A4%EB%B0%9C%EA%B2%AC-%ED%8E%98%EC%9D%B4%EC%A7%80-%EB%A9%94%EB%AA%A8%EB%A6%AC-%EB%88%84%EC%88%98-%ED%95%B4%EA%B2%B0) |
 
-<p float="left">  
-<img width="40%" src="https://github.com/Runnect/Runnect-Android/assets/89737271/66ffac66-9d0a-4bcf-a06b-534283405e4b.jpg">
- 
-<img width="40%" src="https://github.com/Runnect/Runnect-Android/assets/89737271/5c47b594-6f82-444b-9258-ce0882f26fa6.jpg">
-</p>

app/src/main/java/com/runnect/runnect/data/dto/response/base/ErrorResponse.kt

@@ -0,0 +1,18 @@
+package com.runnect.runnect.data.dto.response.base
+
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+
+@Serializable
+data class ErrorResponse<T>(
+    @SerialName("status")
+    val status: Int,
+    @SerialName("success")
+    val success: Boolean?,
+    @SerialName("message")
+    val message: String?,
+    @SerialName("error")
+    val error: String?,
+    @SerialName("data")
+    val data: T? = null
+)

app/src/main/java/com/runnect/runnect/data/network/calladapter/ResultCall.kt

@@ -0,0 +1,80 @@
+package com.runnect.runnect.data.network.calladapter
+
+import com.google.gson.Gson
+import com.runnect.runnect.data.dto.response.base.ErrorResponse
+import com.runnect.runnect.domain.common.RunnectException
+import retrofit2.Call
+import retrofit2.Callback
+import retrofit2.Response
+import okhttp3.Request
+import okio.Timeout
+
+class ResultCall<T>(private val call: Call<T>) : Call<Result<T>> {
+
+    private val gson = Gson()
+
+    override fun execute(): Response<Result<T>> {
+        throw UnsupportedOperationException("ResultCall doesn't support execute")
+    }
+
+    override fun enqueue(callback: Callback<Result<T>>) {
+        call.enqueue(object : Callback<T> {
+            override fun onResponse(call: Call<T>, response: Response<T>) {
+                val apiResult = if (response.isSuccessful) {
+                    response.body()?.let {
+                        Result.success(it)
+                    } ?: Result.failure(
+                        RunnectException(
+                            code = response.code(),
+                            message = ERROR_MSG_RESPONSE_IS_NULL
+                        )
+                    )
+                } else {
+                    Result.failure(parseErrorResponse(response))
+                }
+
+                callback.onResponse(
+                    this@ResultCall,
+                    Response.success(apiResult)
+                )
+            }
+
+            override fun onFailure(call: Call<T>, t: Throwable) {
+                callback.onFailure(this@ResultCall, t)
+            }
+        })
+    }
+
+    private fun parseErrorResponse(response: Response<*>): RunnectException {
+        val errorJson = response.errorBody()?.string()
+
+        return runCatching {
+            val errorBody = gson.fromJson(errorJson, ErrorResponse::class.java)
+            val message = errorBody?.run {
+                message ?: error ?: ERROR_MSG_COMMON
+            }
+
+            RunnectException(
+                code = errorBody.status,
+                message = message
+            )
+        }.getOrElse {
+            RunnectException(
+                code = response.code(),
+                message = ERROR_MSG_COMMON
+            )
+        }
+    }
+
+    override fun clone(): Call<Result<T>> = ResultCall(call.clone())
+    override fun isExecuted(): Boolean = call.isExecuted
+    override fun cancel() = call.cancel()
+    override fun isCanceled(): Boolean = call.isCanceled
+    override fun request(): Request = call.request()
+    override fun timeout(): Timeout = call.timeout()
+
+    companion object {
+        private const val ERROR_MSG_COMMON = "알 수 없는 에러가 발생하였습니다."
+        private const val ERROR_MSG_RESPONSE_IS_NULL = "데이터를 불러올 수 없습니다."
+    }
+}

app/src/main/java/com/runnect/runnect/data/network/calladapter/ResultCallAdapter.kt

@@ -0,0 +1,17 @@
+package com.runnect.runnect.data.network.calladapter
+
+import retrofit2.Call
+import retrofit2.CallAdapter
+import java.lang.reflect.Type
+
+class ResultCallAdapter<T>(
+    private val responseType: Type
+) : CallAdapter<T, Call<Result<T>>> {
+
+    override fun responseType() = responseType
+
+    // Retrofit의 Call을 Result<>로 변환
+    override fun adapt(call: Call<T>): Call<Result<T>> {
+        return ResultCall(call)
+    }
+}

app/src/main/java/com/runnect/runnect/data/network/calladapter/ResultCallAdapterFactory.kt

@@ -0,0 +1,46 @@
+package com.runnect.runnect.data.network.calladapter
+
+import retrofit2.Call
+import retrofit2.CallAdapter
+import retrofit2.Retrofit
+import java.lang.reflect.ParameterizedType
+import java.lang.reflect.Type
+
+class ResultCallAdapterFactory private constructor() : CallAdapter.Factory() {
+
+    override fun get(
+        returnType: Type,
+        annotations: Array<Annotation>,
+        retrofit: Retrofit
+    ): CallAdapter<*, *>? {
+        // 최상위 타입이 Call인지 체크(suspend로 선언시 Call로 감싸짐)
+        if (getRawType(returnType) != Call::class.java) {
+            return null
+        }
+
+        check(returnType is ParameterizedType) {
+            "Call return type must be parameterized as Call<Foo> or Call<out Foo>"
+        }
+
+        val responseType = getParameterUpperBound(0, returnType)
+        if (getRawType(responseType) != Result::class.java) {
+            return null
+        }
+
+        check(responseType is ParameterizedType) {
+            "ApiResult return type must be parameterized as ApiResult<Foo> or ApiResult<out Foo>"
+        }
+
+        return ResultCallAdapter<Any>(
+            getParameterUpperBound(
+                0,
+                responseType
+            )
+        )
+    }
+
+    companion object {
+        @JvmStatic
+        fun create() = ResultCallAdapterFactory()
+    }
+}

app/src/main/java/com/runnect/runnect/data/network/interceptor/ResponseInterceptor.kt

@@ -0,0 +1,55 @@
+package com.runnect.runnect.data.network.interceptor
+
+import com.google.gson.Gson
+import com.google.gson.JsonParseException
+import com.google.gson.JsonSyntaxException
+import com.runnect.runnect.data.dto.response.base.BaseResponse
+import okhttp3.Interceptor
+import okhttp3.MediaType.Companion.toMediaTypeOrNull
+import okhttp3.Response
+import okhttp3.ResponseBody.Companion.toResponseBody
+import timber.log.Timber
+
+/**
+ * BaseResponse에서 data만 추출 (불필요한 래핑 제거)
+ * - 서버에서 내려준 형식이 아니라면 응답 그대로 반환
+ */
+class ResponseInterceptor : Interceptor {
+
+    private val gson = Gson()
+
+    override fun intercept(chain: Interceptor.Chain): Response {
+        val originalResponse = chain.proceed(chain.request())
+        if (!originalResponse.isSuccessful) return originalResponse
+
+        val bodyString = originalResponse.peekBody(Long.MAX_VALUE).string()
+        val newResponseBodyString = jsonToBaseResponse(bodyString)?.let {
+            it.toResponseBody("application/json".toMediaTypeOrNull())
+        } ?: return originalResponse
+
+        return originalResponse.newBuilder()
+            .code(originalResponse.code)
+            .body(newResponseBodyString)
+            .build()
+            .apply {
+                Timber.v("""\n
+                    origin = ${originalResponse.peekBody(Long.MAX_VALUE).string()}
+                    new = ${this.peekBody(Long.MAX_VALUE).string()}
+                    """.trimIndent()
+                )
+            }
+    }
+
+    private fun jsonToBaseResponse(body: String): String? {
+        return try {
+            val baseResponse = gson.fromJson(body, BaseResponse::class.java)
+            gson.toJson(baseResponse.data)
+        } catch (e: JsonSyntaxException) {
+            null // JSON 구문 분석 오류 발생 시 원래 형식을 반환
+        } catch (e: JsonParseException) {
+            null // JSON 파싱 오류 발생 시 원래 형식을 반환
+        } catch (e: Exception) {
+            null // 기타 예외 발생 시 원래 형식을 반환
+        }
+    }
+}

app/src/main/java/com/runnect/runnect/data/network/mapToFlowResult.kt

@@ -0,0 +1,23 @@
+package com.runnect.runnect.data.network
+
+import com.runnect.runnect.domain.common.RunnectException
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.flow
+
+fun <R, D> Result<R>.mapToFlowResult(
+    mapper: (R) -> D
+): Flow<Result<D>> = flow {
+    val result = when {
+        this@mapToFlowResult.isSuccess -> Result.success(
+            // CallAdapter에서 body가 null인 경우도 걸러주고 있으므로
+            // Result.success의 데이터가 null인 경우는 없을듯함
+            mapper(this@mapToFlowResult.getOrNull()!!)
+        )
+
+        else -> Result.failure(
+            this@mapToFlowResult.exceptionOrNull() ?: RunnectException()
+        )
+    }
+
+    emit(result)
+}