gateway module

pawlo2102 · pawlo2102 · commit 29faca7bc530 · 2019-10-20T11:34:14.000+03:00
diff --git a/.gradle/buildOutputCleanup/buildOutputCleanup.lock b/.gradle/buildOutputCleanup/buildOutputCleanup.lock
diff --git a/.gradle/buildOutputCleanup/outputFiles.bin b/.gradle/buildOutputCleanup/outputFiles.bin
diff --git a/.idea/caches/build_file_checksums.ser b/.idea/caches/build_file_checksums.ser
diff --git a/.idea/gradle.xml b/.idea/gradle.xml
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/.idea/modules.xml b/.idea/modules.xml
diff --git a/app/app.iml b/app/app.iml
@@ -27,7 +27,7 @@
         <compilerSettings />
         <compilerArguments>
           <option name="destination" value="$MODULE_DIR$/build/tmp/kotlin-classes/debug" />
-          <option name="classpath" value="$USER_HOME$/.gradle/caches/transforms-2/files-2.1/820bbbaec146f241bf471d887cf7b300/jars/classes.jar:/home/pawlo/StudioProjects/coreAndroid/presentation/build/intermediates/compile_library_classes/debug/classes.jar:/home/pawlo/.gradle/caches/transforms-2/files-2.1/7ce5304a9158251d06714d788566f12d/jars/classes.jar:/home/pawlo/.gradle/caches/transforms-2/files-2.1/02af59d8ad68282b204692c0b0c1dc16/jars/classes.jar:/home/pawlo/.gradle/caches/transforms-2/files-2.1/ebcd98112884a9a5f1d8c4c82f666fc5/jars/classes.jar:/home/pawlo/.gradle/caches/modules-2/files-2.1/androidx.collection/collection/1.1.0-rc01/1f27220b47669781457de0d600849a5de0e89909/collection-1.1.0-rc01.jar:/home/pawlo/.gradle/caches/modules-2/files-2.1/androidx.lifecycle/lifecycle-common/2.2.0-alpha01/c67e7807d9cd6c329b9d0218b2ec4e505dd340b7/lifecycle-common-2.2.0-alpha01.jar:/home/pawlo/.gradle/caches/modules-2/files-2.1/androidx.arch.core/core-common/2.1.0-beta01/b3152fc64428c9354344bd89848ecddc09b6f07e/core-common-2.1.0-beta01.jar:/home/pawlo/.gradle/caches/modules-2/files-2.1/androidx.annotation/annotation/1.1.0-rc01/e3a6fb2f40e3a3842e6b7472628ba4ce416ea4c8/annotation-1.1.0-rc01.jar:/home/pawlo/.gradle/caches/modules-2/files-2.1/androidx.databinding/databinding-common/3.4.2/b7c75633f0e744572f7e4264487a35eaf9de11ad/databinding-common-3.4.2.jar:/home/pawlo/StudioProjects/coreAndroid/remote/build/intermediates/compile_library_classes/debug/classes.jar:/home/pawlo/StudioProjects/coreAndroid/retrofit/build/intermediates/compile_library_classes/debug/classes.jar:/home/pawlo/StudioProjects/coreAndroid/networkmanager/build/intermediates/compile_library_classes/debug/classes.jar:/home/pawlo/Android/Sdk/platforms/android-29/android.jar" />
+          <option name="classpath" value="$USER_HOME$/.gradle/caches/transforms-2/files-2.1/820bbbaec146f241bf471d887cf7b300/jars/classes.jar:/home/pawlo/.gradle/caches/transforms-2/files-2.1/7ce5304a9158251d06714d788566f12d/jars/classes.jar:/home/pawlo/.gradle/caches/transforms-2/files-2.1/02af59d8ad68282b204692c0b0c1dc16/jars/classes.jar:/home/pawlo/.gradle/caches/transforms-2/files-2.1/ebcd98112884a9a5f1d8c4c82f666fc5/jars/classes.jar:/home/pawlo/.gradle/caches/modules-2/files-2.1/androidx.collection/collection/1.1.0-rc01/1f27220b47669781457de0d600849a5de0e89909/collection-1.1.0-rc01.jar:/home/pawlo/.gradle/caches/modules-2/files-2.1/androidx.lifecycle/lifecycle-common/2.2.0-alpha01/c67e7807d9cd6c329b9d0218b2ec4e505dd340b7/lifecycle-common-2.2.0-alpha01.jar:/home/pawlo/.gradle/caches/modules-2/files-2.1/androidx.arch.core/core-common/2.1.0-beta01/b3152fc64428c9354344bd89848ecddc09b6f07e/core-common-2.1.0-beta01.jar:/home/pawlo/.gradle/caches/modules-2/files-2.1/androidx.annotation/annotation/1.1.0-rc01/e3a6fb2f40e3a3842e6b7472628ba4ce416ea4c8/annotation-1.1.0-rc01.jar:/home/pawlo/.gradle/caches/modules-2/files-2.1/androidx.databinding/databinding-common/3.4.2/b7c75633f0e744572f7e4264487a35eaf9de11ad/databinding-common-3.4.2.jar:/home/pawlo/Android/Sdk/platforms/android-29/android.jar" />
           <option name="noStdlib" value="true" />
           <option name="noReflect" value="true" />
           <option name="moduleName" value="app_debug" />
@@ -118,7 +118,6 @@
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/compatible_screen_manifest" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/dex" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/duplicate_classes_check" />
-      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/external_libs_dex" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/incremental" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/instant_app_manifest" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/instant_run_merged_manifests" />
diff --git a/gateway/.gitignore b/gateway/.gitignore
@@ -0,0 +1 @@
+/build
diff --git a/gateway/build.gradle b/gateway/build.gradle
@@ -0,0 +1,40 @@
+apply plugin: 'com.android.library'
+apply plugin: 'kotlin-android'
+apply plugin: 'com.github.dcendents.android-maven'
+
+group='com.github.VRGsoftUA'
+
+android {
+    compileSdkVersion sdk_compile_version
+
+    defaultConfig {
+        minSdkVersion sdk_min_version
+        targetSdkVersion sdk_compile_version
+        versionCode version_code
+        versionName version_name
+
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+}
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+
+    rootProject.coreGateway.each {
+        add(it.configuration, it.dependency, it.options)
+    }
+
+    implementation project(':networkmanager')
+    implementation project(':remote')
+}
+
+repositories {
+    mavenCentral()
+}
diff --git a/gateway/proguard-rules.pro b/gateway/proguard-rules.pro
@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile
diff --git a/gateway/src/main/AndroidManifest.xml b/gateway/src/main/AndroidManifest.xml
@@ -0,0 +1,2 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+          package="com.vrgsoft.core.gateway"/>
diff --git a/gateway/src/main/java/com/vrgsoft/core/gateway/BaseGateway.kt b/gateway/src/main/java/com/vrgsoft/core/gateway/BaseGateway.kt
@@ -0,0 +1,30 @@
+package com.vrgsoft.core.gateway
+
+import androidx.annotation.VisibleForTesting
+import com.vrgsoft.core.remote.error.BaseError
+import com.vrgsoft.core.remote.result.BaseResult
+import com.vrgsoft.core.remote.result.ErrorResult
+import com.vrgsoft.networkmanager.Error
+import com.vrgsoft.networkmanager.NetworkManager
+
+abstract class BaseGateway(override val networkManager: NetworkManager) : IBaseGateway {
+
+    @VisibleForTesting(otherwise = VisibleForTesting.PROTECTED)
+    suspend fun <T> executeRemote(call: suspend (() -> BaseResult<T>)): BaseResult<T> {
+        networkManager.startProcessing()
+
+        val result = call.invoke()
+
+        networkManager.stopProcessing()
+
+        if (result is ErrorResult<T>) {
+            val message = calculateMessage(result.error)
+
+            networkManager.errors.call(Error(message))
+        }
+
+        return result
+    }
+
+    abstract fun calculateMessage(error: BaseError): String
+}
diff --git a/gateway/src/main/java/com/vrgsoft/core/gateway/DefaultValues.kt b/gateway/src/main/java/com/vrgsoft/core/gateway/DefaultValues.kt
@@ -0,0 +1,9 @@
+package com.vrgsoft.core.gateway
+
+fun Long?.orMinusOne(): Long = this ?: -1L
+
+fun Long?.orZero(): Long = this ?: 0L
+
+fun Int?.orMinusOne(): Int = this ?: -1
+
+fun Int?.orZero(): Int = this ?: 0
diff --git a/gateway/src/main/java/com/vrgsoft/core/gateway/IBaseGateway.kt b/gateway/src/main/java/com/vrgsoft/core/gateway/IBaseGateway.kt
@@ -0,0 +1,7 @@
+package com.vrgsoft.core.gateway
+
+import com.vrgsoft.networkmanager.NetworkManager
+
+interface IBaseGateway {
+    val networkManager: NetworkManager
+}
diff --git a/gateway/src/main/java/com/vrgsoft/core/gateway/boundary/BaseCallback.kt b/gateway/src/main/java/com/vrgsoft/core/gateway/boundary/BaseCallback.kt
@@ -0,0 +1,52 @@
+package com.vrgsoft.core.gateway.boundary
+
+import androidx.paging.PagedList
+import com.vrgsoft.networkmanager.NetworkManager
+import kotlinx.coroutines.GlobalScope
+import kotlinx.coroutines.channels.Channel
+import kotlinx.coroutines.launch
+
+class BaseCallback<T>(
+    private val networkManager: NetworkManager,
+    private val getAllCount: (suspend () -> Int),
+    private val fetch: (suspend (count: Int) -> Unit)
+) : PagedList.BoundaryCallback<T>() {
+    private var channel = Channel<Int>()
+
+    private suspend fun loadMore() {
+        if (networkManager.processing.value == true) {
+            return
+        }
+
+        val count = getAllCount.invoke()
+        fetch.invoke(count)
+    }
+
+    override fun onZeroItemsLoaded() {
+        super.onZeroItemsLoaded()
+
+        GlobalScope.launch {
+            channel.send(1)
+        }
+    }
+
+    override fun onItemAtEndLoaded(itemAtEnd: T) {
+        super.onItemAtEndLoaded(itemAtEnd)
+
+        GlobalScope.launch {
+            channel.send(1)
+        }
+    }
+
+    init {
+        GlobalScope.launch {
+            while (true) {
+                channel.receive()
+                if (networkManager.processing.value == true) {
+                    continue
+                }
+                loadMore()
+            }
+        }
+    }
+}
diff --git a/gateway/src/main/java/com/vrgsoft/core/gateway/boundary/Ext.kt b/gateway/src/main/java/com/vrgsoft/core/gateway/boundary/Ext.kt
@@ -0,0 +1,23 @@
+package com.vrgsoft.core.gateway.boundary
+
+import androidx.lifecycle.LiveData
+import androidx.paging.DataSource
+import androidx.paging.PagedList
+import androidx.paging.toLiveData
+import com.vrgsoft.networkmanager.NetworkManager
+
+fun <Key, Value> DataSource.Factory<Key, Value>.toLiveData(
+    networkManager: NetworkManager,
+    pageSize: Int,
+    getLocalCount: (suspend () -> Int),
+    fetch: (suspend (count: Int) -> Unit)
+): LiveData<PagedList<Value>> {
+    return this.toLiveData(
+        pageSize = pageSize,
+        boundaryCallback = BaseCallback(
+            networkManager = networkManager,
+            getAllCount = getLocalCount,
+            fetch = fetch
+        )
+    )
+}
diff --git a/gateway/src/main/res/values/strings.xml b/gateway/src/main/res/values/strings.xml
@@ -0,0 +1,3 @@
+<resources>
+    <string name="app_name">Gateway</string>
+</resources>
diff --git a/gateway/src/test/java/com/vrgsoft/core/gateway/BaseGatewayTest.kt b/gateway/src/test/java/com/vrgsoft/core/gateway/BaseGatewayTest.kt
@@ -0,0 +1,59 @@
+package com.vrgsoft.core.gateway
+
+import com.nhaarman.mockitokotlin2.spy
+import com.nhaarman.mockitokotlin2.verify
+import com.vrgsoft.core.gateway.base.LiveDataTest
+import com.vrgsoft.core.remote.error.ConnectionError
+import com.vrgsoft.core.remote.result.BaseResult
+import com.vrgsoft.core.remote.result.ErrorResult
+import com.vrgsoft.core.remote.result.SuccessResult
+import com.vrgsoft.networkmanager.NetworkManager
+import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.ObsoleteCoroutinesApi
+import kotlinx.coroutines.test.runBlockingTest
+import org.junit.Assert
+import org.junit.Test
+
+@ObsoleteCoroutinesApi
+@ExperimentalCoroutinesApi
+class BaseGatewayTest : LiveDataTest() {
+
+    private lateinit var gateway: BaseGateway
+    private lateinit var manager: NetworkManager
+
+    override fun setUpDetail() {
+        manager = spy(NetworkManager())
+        gateway = MockedGateway(manager)
+    }
+
+    @Test
+    fun testSuccess() {
+        val testData = 1488
+        runBlockingTest {
+            val call: (suspend () -> BaseResult<Int>) = {
+                SuccessResult(testData)
+            }
+            val result = gateway.executeRemote(call)
+
+            verify(manager).startProcessing()
+            verify(manager).stopProcessing()
+            Assert.assertEquals(true, result is SuccessResult)
+            Assert.assertEquals(testData, (result as SuccessResult).data)
+        }
+    }
+
+    @Test
+    fun testError() {
+        runBlockingTest {
+            val call: (suspend () -> BaseResult<Int>) = {
+                ErrorResult(ConnectionError())
+            }
+            val result = gateway.executeRemote(call)
+
+            verify(manager).startProcessing()
+            verify(manager).stopProcessing()
+            Assert.assertEquals(true, result is ErrorResult)
+            Assert.assertEquals(true, (result as ErrorResult).error is ConnectionError)
+        }
+    }
+}
diff --git a/gateway/src/test/java/com/vrgsoft/core/gateway/MockedGateway.kt b/gateway/src/test/java/com/vrgsoft/core/gateway/MockedGateway.kt
@@ -0,0 +1,10 @@
+package com.vrgsoft.core.gateway
+
+import com.vrgsoft.core.remote.error.BaseError
+import com.vrgsoft.networkmanager.NetworkManager
+
+class MockedGateway(manager: NetworkManager) : BaseGateway(manager) {
+    override fun calculateMessage(error: BaseError): String {
+        return ""
+    }
+}
diff --git a/gateway/src/test/java/com/vrgsoft/core/gateway/base/LiveDataTest.kt b/gateway/src/test/java/com/vrgsoft/core/gateway/base/LiveDataTest.kt
@@ -0,0 +1,36 @@
+package com.vrgsoft.core.gateway.base
+
+import androidx.arch.core.executor.testing.InstantTaskExecutorRule
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.ObsoleteCoroutinesApi
+import kotlinx.coroutines.newSingleThreadContext
+import kotlinx.coroutines.test.resetMain
+import kotlinx.coroutines.test.setMain
+import org.junit.After
+import org.junit.Before
+import org.junit.Rule
+import org.junit.rules.TestRule
+
+@ObsoleteCoroutinesApi
+@ExperimentalCoroutinesApi
+abstract class LiveDataTest {
+    @get:Rule
+    var rule: TestRule = InstantTaskExecutorRule()
+
+    private val mainThreadSurrogate = newSingleThreadContext("UI thread")
+
+    @Before
+    fun setUp() {
+        Dispatchers.setMain(mainThreadSurrogate)
+        setUpDetail()
+    }
+
+    open fun setUpDetail() {}
+
+    @After
+    fun tearDown() {
+        Dispatchers.resetMain() // reset main dispatcher to the original Main dispatcher
+        mainThreadSurrogate.close()
+    }
+}
diff --git a/gateway/src/test/java/com/vrgsoft/core/gateway/base/assert.kt b/gateway/src/test/java/com/vrgsoft/core/gateway/base/assert.kt
@@ -0,0 +1,26 @@
+package com.vrgsoft.core.gateway.base
+
+import androidx.lifecycle.LiveData
+import androidx.lifecycle.Observer
+import com.nhaarman.mockitokotlin2.argumentCaptor
+import com.nhaarman.mockitokotlin2.mock
+import com.nhaarman.mockitokotlin2.times
+import com.nhaarman.mockitokotlin2.verify
+import kotlinx.coroutines.delay
+import kotlinx.coroutines.runBlocking
+
+inline fun <reified T : Any> LiveData<T>.assert(calls: Int = 2, crossinline assert: ((it: T) -> Unit)) {
+    val observer: Observer<T> = mock()
+    val captor = argumentCaptor<T>()
+
+    runBlocking {
+        this@assert.observeForever(observer)
+
+        delay(1000)
+
+        captor.run {
+            verify(observer, times(calls)).onChanged(capture())
+            assert.invoke(captor.lastValue)
+        }
+    }
+}
diff --git a/gateway/src/test/resources/mockito-extensions/org.mockito.plugins.MockMaker b/gateway/src/test/resources/mockito-extensions/org.mockito.plugins.MockMaker
@@ -0,0 +1 @@
+mock-maker-inline
diff --git a/settings.gradle b/settings.gradle
@@ -1 +1 @@
-include ':app', ':remote', ':retrofit', ':networkmanager', ':presentation'
+include ':app', ':remote', ':retrofit', ':networkmanager', ':presentation', ':gateway'
