Merge pull request #4 from VincentMasselis/chore/callback-refactor

Chore/callback refactor

Author: Vincent Masselis

README.md

@@ -93,7 +93,7 @@ If you're not familiar with the Bluetooth Low Energy API or if you want to try t
 ## Decorator patter
 ⚠ Before reading this part, you must know how a [Decorator design pattern](https://en.wikipedia.org/wiki/Decorator_pattern) works and how to make a new one.
 
-On Android, communicating with a Bluetooth device requires an instance of `BluetoothGatt` and an instance of `BluetoothGattCallback`. RxBluetoothKotlin wraps both of theses types into `RxBluetoothGatt` and `RxBluetoothGatt.Callback` types to add some reactive touch to the system objects. Because `RxBluetoothGatt` is an interface and `BluetoothGattCallback` an abstract class, calling `connectRxGatt` will return a default implentation for both of them. You are free to wrap the returned `RxBluetoothGatt` implementation and update the original object by adding you own behavior, you only have to follow the Decorator rules.
+On Android, communicating with a Bluetooth device requires an instance of `BluetoothGatt` and an instance of `BluetoothGattCallback`. RxBluetoothKotlin wraps both of theses types into `RxBluetoothGatt` and `RxBluetoothGatt.Callback` types to add some reactive touch to the system objects. Both `RxBluetoothGatt` and `RxBluetoothGatt.Callback` are interfaces, calling `connectRxGatt` will return a default implementation for both of them but you are free to wrap the returned implementation by your own implementation to add you own behavior, you only have to follow the Decorator rules.
 
 ### Decorate RxBluetoothGatt
 The following diagram will show you which classes are used to create the decorator pattern:
@@ -114,7 +114,7 @@ On this website `https://yuml.me/diagram/scruffy/class/draw`
 
 As you can see, to create a decorator, you only have to subclass `SimpleRxBluetoothGatt`. If you want to decorate `RxBluetoothGatt.Callback` just subclass `SimpleRxBluetoothGattCallback` like you do with `SimpleRxBluetoothGatt` from the previous example.
 
-When your decorators are written you can send them to RxBluetoothKotlin by adding `callbackConstructor` and `rxGattConstructor` parameters when calling `connectRxGatt`. Defaults implentation of RxBluetoothKotlin uses `RxBluetoothGattImpl` and `RxBluetoothGattCallbackImpl`, by using you own decorator you can change the way RxBluetoothKotlin is communicating with the Android SDK in order to match your own requirements.
+When your decorators are written you can send them to RxBluetoothKotlin by setting the `rxGattBuilder` and `rxCallbackBuilder` parameters when calling `connectRxGatt`. Defaults implementation of RxBluetoothKotlin uses `RxBluetoothGattImpl` and `RxBluetoothGattCallbackImpl`, by using you own decorator you can change the way RxBluetoothKotlin is communicating with the Android SDK in order to match your own requirements.
 
 ## Links
 Report an issue by using [github](https://github.com/VincentMasselis/RxBluetoothKotlin/issues)
@@ -125,10 +125,6 @@ Discover our [Equisense sensors](https://equisense.com)
 
 //TODO 
 
-- More test
-
 - Getting started
 
-- Example app
-
 - Licence

build.gradle

@@ -36,5 +36,5 @@ task clean(type: Delete) {
 ext {
     versionCode = "$System.env.BITRISE_BUILD_NUMBER"
     groupId = 'com.vincentmasselis.rxbluetoothkotlin'
-    libVersion = "1.2.2"
+    libVersion = "1.3.0"
 }

demo-app/app/src/main/AndroidManifest.xml

@@ -6,7 +6,7 @@
         android:name="android.hardware.bluetooth_le"
         android:required="true" />
 
-    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
+    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
 
     <application
         android:allowBackup="true"

dev-app/build.gradle

@@ -3,11 +3,11 @@ apply plugin: 'kotlin-android'
 apply plugin: 'kotlin-android-extensions'
 
 android {
-    compileSdkVersion 28
+    compileSdkVersion 29
     defaultConfig {
         applicationId "com.vincentmasselis.app"
         minSdkVersion 18
-        targetSdkVersion 28
+        targetSdkVersion 29
         versionCode 1
         versionName "1.0"
 
@@ -27,13 +27,13 @@ dependencies {
     testImplementation 'junit:junit:4.12'
     testImplementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
     testImplementation "org.jetbrains.kotlin:kotlin-test-junit:$kotlin_version"
-    testImplementation 'io.reactivex.rxjava2:rxjava:2.2.11'
+    testImplementation 'io.reactivex.rxjava2:rxjava:2.2.13'
 
     androidTestImplementation 'androidx.test.ext:junit:1.1.1'
     androidTestImplementation 'androidx.test:runner:1.2.0'
     androidTestImplementation 'com.android.support.test:rules:1.0.2'
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
-    androidTestImplementation 'io.reactivex.rxjava2:rxjava:2.2.11'
+    androidTestImplementation 'io.reactivex.rxjava2:rxjava:2.2.13'
     androidTestImplementation 'io.reactivex.rxjava2:rxkotlin:2.3.0'
     androidTestImplementation 'no.nordicsemi.android.support.v18:scanner:1.4.0'
 
@@ -42,7 +42,7 @@ dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
     implementation 'androidx.appcompat:appcompat:1.1.0'
     implementation 'androidx.core:core-ktx:1.1.0'
-    implementation 'io.reactivex.rxjava2:rxjava:2.2.11'
+    implementation 'io.reactivex.rxjava2:rxjava:2.2.13'
     implementation 'no.nordicsemi.android.support.v18:scanner:1.4.0'
     implementation 'com.vincentmasselis.rxuikotlin:rxuikotlin-core:1.2.0'
 

dev-app/src/androidTest/java/com/vincentmasselis/devapp/DisconnectionTests.kt

@@ -40,6 +40,7 @@ class DisconnectionTests {
                 gatt.whenConnectionIsReady().map { gatt }
             }
             .doOnSuccess { activity.setMessage("Discovering services") }
+            .delay(600, TimeUnit.MILLISECONDS)
             .flatMap { gatt -> gatt.discoverServices().doOnSubscribe { Logger.v(TAG, "Subscribing to fetch services") }.map { gatt } }
             .timeout(20, TimeUnit.SECONDS)
             .doOnError { Logger.e(TAG, "Failed, reason :$it") }
@@ -67,6 +68,7 @@ class DisconnectionTests {
                 gatt.whenConnectionIsReady().map { gatt }
             }
             .doOnSuccess { activity.setMessage("Discovering services") }
+            .delay(600, TimeUnit.MILLISECONDS)
             .flatMap { gatt -> gatt.discoverServices().doOnSubscribe { Logger.v(TAG, "Subscribing to fetch services") }.map { gatt } }
             .timeout(20, TimeUnit.SECONDS)
             .doOnError { Logger.e(TAG, "Failed, reason :$it") }
@@ -110,7 +112,7 @@ class DisconnectionTests {
     fun disconnection5sTest() {
         val activity = mainActivityRule.launchActivity(null)
         bluetoothPreconditions(activity)
-        val gatt = (activity.getSystemService(Context.BLUETOOTH_SERVICE) as BluetoothManager)
+        (activity.getSystemService(Context.BLUETOOTH_SERVICE) as BluetoothManager)
             .rxScan()
             .doOnSubscribe { activity.setMessage("Please wakeup your device") }
             .filter { it.device.address == DEVICE_MAC } // Write the mac address for your own device here
@@ -122,6 +124,7 @@ class DisconnectionTests {
                 gatt.whenConnectionIsReady().map { gatt }
             }
             .doOnSuccess { activity.setMessage("Discovering services") }
+            .delay(600, TimeUnit.MILLISECONDS)
             .flatMap { gatt -> gatt.discoverServices().doOnSubscribe { Logger.v(TAG, "Subscribing to fetch services") }.map { gatt } }
             .flatMapCompletable { it.listenDisconnection().doOnSubscribe { Logger.v(TAG, "Listening for disconnection") } }
             .timeout(20, TimeUnit.SECONDS)
@@ -147,6 +150,7 @@ class DisconnectionTests {
             .flatMapSingleElement { it.device.connectRxGatt(logger = Logger) }
             .flatMap { gatt -> gatt.whenConnectionIsReady().map { gatt } }
             .doOnSuccess { activity.setMessage("Discovering services") }
+            .delay(600, TimeUnit.MILLISECONDS)
             .flatMap { gatt -> gatt.discoverServices().doOnSubscribe { Logger.v(TAG, "Subscribing to fetch services"); gatt.disconnect().subscribe() }.map { gatt } }
             .timeout(20, TimeUnit.SECONDS)
             .doOnError { Logger.e(TAG, "Failed, reason :$it") }

dev-app/src/androidTest/java/com/vincentmasselis/devapp/EnqueueUnitTest.kt

@@ -41,6 +41,7 @@ class EnqueueUnitTest {
             .doOnSuccess { activity.setMessage("Connecting") }
             .flatMapSingleElement { it.device.connectRxGatt(logger = Logger) }
             .flatMap { gatt -> gatt.whenConnectionIsReady().map { gatt } }
+            .delay(600, TimeUnit.MILLISECONDS)
             .doOnSuccess { activity.setMessage("Discovering services") }
             .flatMap { gatt -> gatt.discoverServices().map { gatt } }
             .doOnSuccess { activity.setMessage("Running tests") }
@@ -58,6 +59,7 @@ class EnqueueUnitTest {
             }
             .doOnComplete { throw IllegalStateException("Should not complete here") }
             .doOnError { Logger.e(TAG, "Failed, reason :$it") }
+            .timeout(20L, TimeUnit.SECONDS)
             .test()
             .await()
             .assertValueCount(1)
@@ -83,9 +85,10 @@ class EnqueueUnitTest {
             .doOnSuccess { activity.setMessage("Connecting") }
             .flatMapSingleElement { it.device.connectRxGatt(logger = Logger) }
             .flatMap { gatt -> gatt.whenConnectionIsReady().map { gatt } }
-            .delay(7, TimeUnit.SECONDS) // Small delay to force the sensor switch into 500ms connection interval
             .doOnSuccess { activity.setMessage("Discovering services") }
+            .delay(600, TimeUnit.MILLISECONDS)
             .flatMap { gatt -> gatt.discoverServices().map { gatt } }
+            .delay(7, TimeUnit.SECONDS) // Small delay to force the sensor switch into 500ms connection interval
             .doOnSuccess { activity.setMessage("Running tests") }
             .flatMap { gatt ->
                 Maybes
@@ -104,6 +107,7 @@ class EnqueueUnitTest {
             }
             .doOnSuccess { throw IllegalStateException("Should not succeed here, It should complete with because of the gatt.disconnect() call") }
             .doOnError { Logger.e(TAG, "Failed, reason :$it") }
+            .timeout(20L, TimeUnit.SECONDS)
             .test()
             .await()
             .assertComplete()
@@ -127,6 +131,7 @@ class EnqueueUnitTest {
             .flatMap { gatt -> gatt.whenConnectionIsReady().map { gatt } }
             .doOnSuccess { it.disconnect().subscribe() }
             .doOnSuccess { activity.setMessage("Discovering services") }
+            .delay(600, TimeUnit.MILLISECONDS)
             .flatMap { gatt -> gatt.discoverServices().map { gatt } }
             .doOnSuccess { throw IllegalStateException("Should not succeed here, It should complete with because of the gatt.disconnect() call") }
             .doOnError { Logger.e(TAG, "Failed, reason :$it") }
@@ -194,7 +199,7 @@ class EnqueueUnitTest {
                     .doOnSubscribe { Logger.e(TAG, "I/O Subscription") }
                     .doOnDispose { Logger.e(TAG, "I/O Dispose") }
                     .doOnEvent { t1, t2 -> Logger.e(TAG, "I/O t1 $t1, t2 $t2") }
-                    .doOnSubscribe { activity.postForUI(20L to TimeUnit.MILLISECONDS) { gatt.disconnect().subscribe() } }
+                    .doOnSubscribe { activity.postForUI(10L to TimeUnit.MILLISECONDS) { gatt.disconnect().subscribe() } }
             }
             .doOnError { Logger.e(TAG, "Failed, reason :$it") }
             .timeout(20L, TimeUnit.SECONDS)

dev-app/src/androidTest/java/com/vincentmasselis/devapp/Utils.kt

@@ -8,13 +8,14 @@ import com.vincentmasselis.rxbluetoothkotlin.internal.toObservable
 import io.reactivex.Observable
 import java.util.*
 
-fun bluetoothPreconditions(context: Context) {
-    val bluetoothManager = context.getSystemService(Context.BLUETOOTH_SERVICE) as BluetoothManager
+fun bluetoothPreconditions(activity: TestActivity) {
+    activity.setMessage("Disabling BLE")
+    val bluetoothManager = activity.getSystemService(Context.BLUETOOTH_SERVICE) as BluetoothManager
     bluetoothManager.adapter.disable()
     Thread.sleep(1000)
     bluetoothManager.adapter.enable()
     IntentFilter(BluetoothAdapter.ACTION_STATE_CHANGED)
-        .toObservable(context)
+        .toObservable(activity)
         .map { (_, intent) -> intent.getIntExtra(BluetoothAdapter.EXTRA_STATE, BluetoothAdapter.ERROR) }
         .startWith(Observable.fromCallable {
             if (bluetoothManager.adapter.isEnabled) BluetoothAdapter.STATE_ON
@@ -23,7 +24,10 @@ fun bluetoothPreconditions(context: Context) {
         .filter { it == BluetoothAdapter.STATE_ON }
         .blockingFirst()
 
-    Thread.sleep(200)
+
+    activity.setMessage("Enabling BLE")
+
+    Thread.sleep(1000)
 }
 
 val BATTERY_CHARACTERISTIC: UUID = UUID.fromString("00002A19-0000-1000-8000-00805F9B34FB")

rxbluetoothkotlin-core/build.gradle

@@ -6,12 +6,12 @@ apply plugin: 'maven-publish'
 
 
 android {
-    compileSdkVersion 28
+    compileSdkVersion 29
     buildToolsVersion "28.0.3"
 
     defaultConfig {
         minSdkVersion 18
-        targetSdkVersion 28
+        targetSdkVersion 29
         versionCode versionCode
         versionName libVersion
     }
@@ -33,7 +33,7 @@ dokka {
 dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
     implementation 'androidx.appcompat:appcompat:1.1.0'
-    implementation "io.reactivex.rxjava2:rxjava:2.2.11"
+    implementation "io.reactivex.rxjava2:rxjava:2.2.13"
     implementation 'io.reactivex.rxjava2:rxandroid:2.1.1'
     implementation 'no.nordicsemi.android.support.v18:scanner:1.4.0'
 }

rxbluetoothkotlin-core/src/main/kotlin/com/vincentmasselis/rxbluetoothkotlin/BluetoothDevice+rx.kt

@@ -18,12 +18,13 @@ private const val TAG = "BluetoothDevice+rx"
  * listen the [io.reactivex.MaybeObserver.onSuccess] event from the [Maybe] returned by
  * [whenConnectionIsReady] method.
  *
- * @param autoConnect similar to "autoConnect" from the [BluetoothDevice.connectGatt] method. Use it wisely.
  * @param logger Set a [logger] to log every event which occurs from the BLE API (connections, writes, notifications, MTU, missing permissions, etc...).
- * @param rxGattConstructor Defaults uses a [RxBluetoothGattImpl] instance but you can fill you own. It can be useful if you want to add some business logic between the default
- * [RxBluetoothGatt] and the system.
- * @param callbackConstructor Defaults uses a [RxBluetoothGattCallbackImpl] instance but you can fill you own. It can be useful if you want to add some business logic between the default
- * [RxBluetoothGatt.Callback] and the system.
+ * @param rxGattBuilder Defaults uses a [RxBluetoothGattImpl] instance but you can fill you own. It can be useful if you want to add some business logic between the default
+ * [RxBluetoothGatt] implementation and the system.
+ * @param connectGattWrapper Default calls [BluetoothDevice.connectGatt]. If you want to use an other variant of [BluetoothDevice.connectGatt] regarding to your requirements,
+ * replace the default implementation by your own.
+ * @param rxCallbackBuilder Defaults uses a [RxBluetoothGattCallbackImpl] instance but you can fill you own. It can be useful if you want to add some business logic between the
+ * default [RxBluetoothGatt.Callback] implementation and the system.
  *
  * @return
  * onSuccess with a [BluetoothGatt] when a [BluetoothGatt] instance is returned by the system API.
@@ -35,10 +36,17 @@ private const val TAG = "BluetoothDevice+rx"
  */
 @Suppress("UNCHECKED_CAST")
 fun <T : RxBluetoothGatt.Callback, E : RxBluetoothGatt> BluetoothDevice.connectTypedRxGatt(
-    autoConnect: Boolean = false,
     logger: Logger? = null,
-    callbackConstructor: (() -> T) = { RxBluetoothGattCallbackImpl().let { concrete -> logger?.let { CallbackLogger(it, concrete) } ?: concrete } as T },
-    rxGattConstructor: ((BluetoothGatt, T) -> E) = { gatt, callbacks -> RxBluetoothGattImpl(logger, gatt, callbacks) as E }
+    rxCallbackBuilder: () -> T = {
+        RxBluetoothGattCallbackImpl().let { concrete -> logger?.let { CallbackLogger(it, concrete) } ?: concrete } as T
+    },
+    connectGattWrapper: (Context, BluetoothGattCallback) -> BluetoothGatt? = { context, callback ->
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) connectGatt(context, false, callback, BluetoothDevice.TRANSPORT_LE)
+        else connectGatt(context, false, callback)
+    },
+    rxGattBuilder: (BluetoothGatt, T) -> E = { gatt, callbacks ->
+        RxBluetoothGattImpl(logger, gatt, callbacks) as E
+    }
 ): Single<E> = Single
     .fromCallable {
 
@@ -48,32 +56,46 @@ fun <T : RxBluetoothGatt.Callback, E : RxBluetoothGatt> BluetoothDevice.connectT
         }
 
         val btState =
-            if ((ContextHolder.context.getSystemService(Context.BLUETOOTH_SERVICE) as BluetoothManager).adapter.isEnabled) BluetoothAdapter.STATE_ON else BluetoothAdapter.STATE_OFF
+            if ((ContextHolder.context.getSystemService(Context.BLUETOOTH_SERVICE) as BluetoothManager).adapter.isEnabled)
+                BluetoothAdapter.STATE_ON
+            else
+                BluetoothAdapter.STATE_OFF
 
         if (btState == BluetoothAdapter.STATE_OFF) {
             logger?.v(TAG, "Bluetooth is off")
             throw BluetoothIsTurnedOff()
         }
 
-        val callbacks = callbackConstructor()
+        val callbacks = rxCallbackBuilder()
 
-        logger?.v(TAG, "connectGatt with autoConnect $autoConnect")
-        val gatt = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) connectGatt(ContextHolder.context, autoConnect, callbacks, BluetoothDevice.TRANSPORT_LE)
-        else connectGatt(ContextHolder.context, autoConnect, callbacks)
+        val gatt = connectGattWrapper(ContextHolder.context, callbacks.source)
 
         if (gatt == null) {
             logger?.v(TAG, "connectGatt method returned null")
             throw NullBluetoothGatt()
         }
 
-        return@fromCallable rxGattConstructor(gatt, callbacks)
+        return@fromCallable rxGattBuilder(gatt, callbacks)
     }
     .subscribeOn(AndroidSchedulers.mainThread())
 
 /** @see connectTypedRxGatt */
 fun BluetoothDevice.connectRxGatt(
-    autoConnect: Boolean = false,
     logger: Logger? = null,
-    callbackConstructor: (() -> RxBluetoothGatt.Callback) = { RxBluetoothGattCallbackImpl().let { concrete -> logger?.let { CallbackLogger(it, concrete) } ?: concrete } },
-    rxGattConstructor: ((BluetoothGatt, RxBluetoothGatt.Callback) -> RxBluetoothGatt) = { gatt, callbacks -> RxBluetoothGattImpl(logger, gatt, callbacks) }
-) = connectTypedRxGatt(autoConnect, logger, callbackConstructor, rxGattConstructor)
+    rxCallbackBuilder: (() -> RxBluetoothGatt.Callback) = {
+        RxBluetoothGattCallbackImpl().let { concrete -> logger?.let { CallbackLogger(it, concrete) } ?: concrete }
+    },
+    connectGattWrapper: (Context, BluetoothGattCallback) -> BluetoothGatt? = { context, callback ->
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) connectGatt(context, false, callback, BluetoothDevice.TRANSPORT_LE)
+        else connectGatt(context, false, callback)
+    },
+    rxGattBuilder: ((BluetoothGatt, RxBluetoothGatt.Callback) -> RxBluetoothGatt) = { gatt, callbacks ->
+        RxBluetoothGattImpl(logger, gatt, callbacks)
+    }
+) =
+    connectTypedRxGatt(
+        logger,
+        rxCallbackBuilder,
+        connectGattWrapper,
+        rxGattBuilder
+    )