Merge pull request #1 from AshwinN796/detect_network_type

updated to receive internet speed-type
AshwinN796 · Jan 16, 2020 · b55ba98 · b55ba98
2 parents 7028b76 + 764442a
commit b55ba98
Show file tree

Hide file tree

Showing 13 changed files with 236 additions and 49 deletions.
diff --git a/README.md b/README.md
@@ -1,73 +1,89 @@
-## NetworkListener ![](https://jitpack.io/v/AshwinN796/networkListener.svg)
+# NetworkListener ![](https://jitpack.io/v/AshwinN796/networkListener.svg)
+
 NetworkLister is the library to check the internet connection status of device at runtime.
 
-## SetUp
-##### project level gradle
-```
+
+## New Features!
+  - Now detect runtime internet speed status
+
+### Installation
+#### Project level gradle
+
+```Gradle
 allprojects {
  repositories {
-    ...
     maven { url 'https://jitpack.io' }
  }
 }
-
-```
-
-#### module level gradle
 ```
-implementation 'com.github.AshwinN796:networkListener:1.0.4'
 
+#### Module level gradle
+```Gradle
+implementation 'com.github.AshwinN796:networkListener:1.1.0'
 ```
 
-## How to use
+##### Implementation
+Application class :
 
-#### In your application class
-```
+```Kotlin
 class MyApplication : Application() {
 
-    override fun onCreate() {
-        super.onCreate()
-	//init network class here
-        NetworkConfig.initNetworkConfig(this)
-    }
+       override fun onCreate() {
+           super.onCreate()
+           //init NetworkConfig
+           NetworkConfig.initNetworkConfig(this)
+       }
 
-    override fun onLowMemory() {
-        super.onLowMemory()
-        //Remove all listeners while on low memory
-        NetworkConfig.getInstance().removeAllNetworkConnectivityListener()
-
-        }
-    }
+       override fun onLowMemory() {
+           super.onLowMemory()
+           //Remove all listeners while on low memory
+           NetworkConfig.getInstance().removeAllNetworkConnectivityListener()
 
+       }
+   }
 ```
+Activity class :
 
-#### In your activity class
-```
+```Kotlin
 class MainActivity : AppCompatActivity(), NetworkStateListener {
 
     private var networkConfig : NetworkConfig? = null
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         setContentView(R.layout.activity_main)
-	
-	//get instance of networkConfig class
+
+        //Get instance of networkConfig class
         networkConfig = NetworkConfig.getInstance()
-	
-	//add listener for NetworkConfig
+
+        //add connectivity listener
         networkConfig!!.addNetworkConnectivityListener(this)
     }
 
     override fun onDestroy() {
         super.onDestroy()
-	//remove listener from NetworkConfig
+        //remove connectivity listener
         networkConfig!!.removeNetworkConnectivityListener(this)
     }
 
+    /*
+        Do action on network status changed
+        Here you can perform any action for Network state listener depending on your requirement.
+     */
     override fun onNetworkStatusChanged(isConnected: Boolean) {
-        when(isConnected){
-            true -> Toast.makeText(this@MainActivity,"Internet Connected",Toast.LENGTH_LONG).show()
-            false -> Toast.makeText(this@MainActivity,"Internet Failed",Toast.LENGTH_LONG).show()
+
+//        when(isConnected){
+//            true -> {//make your action}
+//            false -> {}
+//        }
+    }
+
+    override fun onNetworkSpeedChanged(speedType: Int) {
+        when(speedType) {
+            NetworkConstant.WIFI_CONNECTED -> {//make your action}
+            NetworkConstant.FULL_SPEED_CONNECTED -> {}
+            NetworkConstant.SLOW_CONNECTED ->  {}
+            NetworkConstant.LOW_SPEED_CONNECTED -> {}
         }
     }
 }

diff --git a/app/build.gradle b/app/build.gradle
@@ -38,4 +38,5 @@ dependencies {
     testImplementation testLibraries.junit4
     androidTestImplementation androidTestLibraries.testRunner
     androidTestImplementation androidTestLibraries.espressoCore
+    androidTestImplementation androidTestLibraries.androidXJUnit
 }
diff --git a/app/src/main/java/com/kknirmale/networkstatelistener/MainActivity.kt b/app/src/main/java/com/kknirmale/networkstatelistener/MainActivity.kt
@@ -5,6 +5,7 @@ import android.os.Bundle
 import android.widget.Toast
 import com.kknirmale.networkhandler.config.NetworkConfig
 import com.kknirmale.networkhandler.listener.NetworkStateListener
+import com.kknirmale.networkhandler.utils.NetworkConstant
 
 class MainActivity : AppCompatActivity(), NetworkStateListener {
 
@@ -32,9 +33,19 @@ class MainActivity : AppCompatActivity(), NetworkStateListener {
         Here you can perform any action for Network state listener depending on your requirement.
      */
     override fun onNetworkStatusChanged(isConnected: Boolean) {
-        when(isConnected){
-            true -> Toast.makeText(this@MainActivity,"Internet Connected",Toast.LENGTH_LONG).show()
-            false -> Toast.makeText(this@MainActivity,"Internet Failed",Toast.LENGTH_LONG).show()
+
+//        when(isConnected){
+//            true -> Toast.makeText(this@MainActivity,"Internet Connected",Toast.LENGTH_LONG).show()
+//            false -> Toast.makeText(this@MainActivity,"Internet Failed",Toast.LENGTH_LONG).show()
+//        }
+    }
+
+    override fun onNetworkSpeedChanged(speedType: Int) {
+        when(speedType) {
+            NetworkConstant.WIFI_CONNECTED -> Toast.makeText(this@MainActivity,"Wifi Connected",Toast.LENGTH_LONG).show()
+            NetworkConstant.FULL_SPEED_CONNECTED -> Toast.makeText(this@MainActivity,"Full Speed Connected",Toast.LENGTH_LONG).show()
+            NetworkConstant.SLOW_CONNECTED ->  Toast.makeText(this@MainActivity,"No internet",Toast.LENGTH_LONG).show()
+            NetworkConstant.LOW_SPEED_CONNECTED ->  Toast.makeText(this@MainActivity,"Slow internet",Toast.LENGTH_LONG).show()
         }
     }
 }
diff --git a/build.gradle b/build.gradle
@@ -5,19 +5,21 @@ buildscript {
 
     ext {
         kotlin_version = '1.3.41'
-        gradle_version = '3.5.0'
+        gradle_version = '3.5.2'
 
         appMinSdkVersion = 21
         appTargetSdkVersion = 29
         appCompileSdkVersion = 29
 
-        currentVersionCode = 1
-        currentVersionName = '1.0.0'
+        currentVersionCode = 2
+        currentVersionName = '1.1.0'
 
         androidx_libs_version = '1.1.0'
         android_constraint_version = '1.1.3'
 
         junit4Version = '4.12'
+        roboElectricVersion = '4.3'
+        andoridxJUnitVersion = '1.1.1'
         testRunnerVersion = '1.1.0'
         testEspressoVersion = '3.1.0'
 
@@ -29,10 +31,12 @@ buildscript {
         ]
 
         testLibraries = [
-                junit4   : "junit:junit:" + junit4Version
+                junit4   : "junit:junit:" + junit4Version,
+                roboElectric : "org.robolectric:robolectric:" + roboElectricVersion
         ]
 
         androidTestLibraries = [
+                androidXJUnit : "androidx.test.ext:junit:" + andoridxJUnitVersion,
                 testRunner: "androidx.test:runner:" + testRunnerVersion,
                 espressoCore : "androidx.test.espresso:espresso-core:" + testEspressoVersion
         ]

diff --git a/gradle.properties b/gradle.properties
@@ -19,3 +19,6 @@ android.useAndroidX=true
 android.enableJetifier=true
 # Kotlin code style for this project: "official" or "obsolete":
 kotlin.code.style=official
+
+# Added for roboelectric test framework
+android.enableUnitTestBinaryResources=true
diff --git a/networkhandler/build.gradle b/networkhandler/build.gradle
@@ -23,6 +23,12 @@ android {
         }
     }
 
+    testOptions {
+        unitTests {
+            includeAndroidResources = true
+        }
+    }
+
 }
 
 dependencies {
@@ -33,6 +39,9 @@ dependencies {
     implementation androidxLibraries.kotlin_core
 
     testImplementation testLibraries.junit4
+    testImplementation testLibraries.roboElectric
     androidTestImplementation androidTestLibraries.testRunner
     androidTestImplementation androidTestLibraries.espressoCore
+    androidTestImplementation androidTestLibraries.androidXJUnit
+
 }
diff --git a/networkhandler/src/androidTest/java/com/kknirmale/networkhandler/ExampleInstrumentedTest.kt b/networkhandler/src/androidTest/java/com/kknirmale/networkhandler/ExampleInstrumentedTest.kt
@@ -1,7 +1,7 @@
 package com.kknirmale.networkhandler
 
 import androidx.test.platform.app.InstrumentationRegistry
-import androidx.test.ext.junit.runners.AndroidJUnit4
+import androidx.test.internal.runner.junit4.AndroidJUnit4ClassRunner
 
 import org.junit.Test
 import org.junit.runner.RunWith
@@ -13,7 +13,7 @@ import org.junit.Assert.*
  *
  * See [testing documentation](http://d.android.com/tools/testing).
  */
-@RunWith(AndroidJUnit4::class)
+@RunWith(AndroidJUnit4ClassRunner::class)
 class ExampleInstrumentedTest {
     @Test
     fun useAppContext() {

diff --git a/networkhandler/src/main/java/com/kknirmale/networkhandler/config/NetworkConfig.kt b/networkhandler/src/main/java/com/kknirmale/networkhandler/config/NetworkConfig.kt
@@ -16,6 +16,10 @@ import java.lang.ref.WeakReference
  */
 class NetworkConfig(context: Context) : NetworkStateReceiver.InternetCheckListener{
 
+    override fun onInternetSpeed(speedType: Int) {
+        reportNetworkSpeedType(speedType)
+    }
+
     override fun onComplete(connected: Boolean) {
         if (connected){
             reportInternetAvailabilityStatus(connected)
@@ -55,6 +59,7 @@ class NetworkConfig(context: Context) : NetworkStateReceiver.InternetCheckListen
     private var networkChangeReceiver : NetworkStateReceiver? = null
     private var isNetworkStatusRegistered = false
     private var isNetworkConnected = false
+    private var networkTypeValue = 0
 
     init {
         val appContext = context.applicationContext
@@ -126,7 +131,39 @@ class NetworkConfig(context: Context) : NetworkStateReceiver.InternetCheckListen
     }
 
     /*
-        Attach connectivity listener to listen network state from broadcast receiver
+        Get report of internet speed value from from listener
+     */
+    private fun reportNetworkSpeedType(speedType : Int) {
+        networkTypeValue = speedType
+        if (networkStateListenerWeakReferenceList == null){
+            return
+        }
+
+        val listenerIterator : MutableIterator<WeakReference<NetworkStateListener>> = networkStateListenerWeakReferenceList!!.iterator()
+        while (listenerIterator.hasNext()){
+
+            val listenerReference : WeakReference<NetworkStateListener> = listenerIterator.next()
+            if (listenerReference == null){
+                listenerIterator.remove()
+                continue
+            }
+
+            val statusListener : NetworkStateListener = listenerReference.get()!!
+            if (statusListener == null){
+                listenerIterator.remove()
+                continue
+            }
+
+            statusListener.onNetworkSpeedChanged(speedType)
+        }
+
+        if (networkStateListenerWeakReferenceList!!.isEmpty()){
+            unregisterNetworkChangeReceiver()
+        }
+    }
+
+    /*
+        Attach all connectivity listener to listen network state from broadcast receiver
     */
     fun addNetworkConnectivityListener(statusListener: NetworkStateListener){
         if (statusListener == null){
@@ -140,6 +177,7 @@ class NetworkConfig(context: Context) : NetworkStateReceiver.InternetCheckListen
         }
 
         reportInternetAvailabilityStatus(isNetworkConnected)
+        reportNetworkSpeedType(networkTypeValue)
 
     }
 
@@ -205,8 +243,5 @@ class NetworkConfig(context: Context) : NetworkStateReceiver.InternetCheckListen
     }
 
 
-//    companion object{
-//        var lock : Objec
-//    }
-
 }
+
diff --git a/networkhandler/src/main/java/com/kknirmale/networkhandler/listener/NetworkStateListener.kt b/networkhandler/src/main/java/com/kknirmale/networkhandler/listener/NetworkStateListener.kt
@@ -9,4 +9,6 @@ Created by Ashwin Nirmale on 17 October,2019
 interface NetworkStateListener {
 
     fun onNetworkStatusChanged(isConnected : Boolean)
+
+    fun onNetworkSpeedChanged(speedType : Int)
 }
diff --git a/networkhandler/src/main/java/com/kknirmale/networkhandler/receivers/NetworkStateReceiver.kt b/networkhandler/src/main/java/com/kknirmale/networkhandler/receivers/NetworkStateReceiver.kt
@@ -21,6 +21,7 @@ class NetworkStateReceiver : BroadcastReceiver() {
         val internetChangeListener : InternetCheckListener = internetListenerReference!!.get()!!
 
         internetChangeListener.onComplete(NetworkUtil(context!!).isConnectedToMobileOrWifi())
+        internetChangeListener.onInternetSpeed(NetworkUtil(context).isInternetHasSpeed())
     }
 
     /*
@@ -42,6 +43,7 @@ class NetworkStateReceiver : BroadcastReceiver() {
 
     interface InternetCheckListener {
         fun onComplete(connected: Boolean)
+        fun onInternetSpeed(speedType : Int)
     }
 
 

diff --git a/networkhandler/src/main/java/com/kknirmale/networkhandler/utils/NetworkConstant.kt b/networkhandler/src/main/java/com/kknirmale/networkhandler/utils/NetworkConstant.kt
@@ -0,0 +1,13 @@
+package com.kknirmale.networkhandler.utils
+
+/**
+ * Created by Ashwin Nirmale on 2020-01-16.
+ */
+object NetworkConstant {
+
+    const val SLOW_CONNECTED = 0
+    const val LOW_SPEED_CONNECTED = 1
+    const val WIFI_CONNECTED = 2
+    const val FULL_SPEED_CONNECTED =3
+
+}