Mock callbacks

mockrxandroidble/README.md

@@ -38,7 +38,17 @@ RxBleClient rxBleClientMock = new RxBleClientMock.Builder()
                             .addDescriptor(descriptorUUID, descriptorData) // <-- adding descriptor mocks
                             .build() // to the characteristic, there can be multiple of them
                     ).build()
-            ).build()
+            ).characteristicReadCallback(characteristicUUID, (device, characteristic, result) -> {
+                result.success(characteristicValue);
+            })
+            .characteristicWriteCallback(characteristicUUID, (device, characteristic, bytes, result) -> {
+                if(writeData(characteristic, bytes)) {
+                    result.success();
+                } else {
+                    result.failure(0x80);
+                    // can also use result.disconnect(0x80); 
+                }
+            }).build()
         ).build()
     ).build();
 

mockrxandroidble/src/main/java/com/polidea/rxandroidble2/mockrxandroidble/Callbacks/Results/RxBleGattReadResultMock.java

@@ -0,0 +1,24 @@
+package com.polidea.rxandroidble2.mockrxandroidble.Callbacks.Results;
+
+/**
+ * An interface for the user to respond to a read request
+ */
+public interface RxBleGattReadResultMock {
+    /**
+     * Respond with success
+     * @param data The data to be returned in response to the read request
+     */
+    void success(byte[] data);
+
+    /**
+     * Respond with failure
+     * @param status The ATT status (error code)
+     */
+    void failure(int status);
+
+    /**
+     * Trigger a disconnection
+     * @param status The disconnection status (error code)
+     */
+    void disconnect(int status);
+}

mockrxandroidble/src/main/java/com/polidea/rxandroidble2/mockrxandroidble/Callbacks/Results/RxBleGattWriteResultMock.java

@@ -0,0 +1,23 @@
+package com.polidea.rxandroidble2.mockrxandroidble.Callbacks.Results;
+
+/**
+ * An interface for the user to respond to a write request
+ */
+public interface RxBleGattWriteResultMock {
+    /**
+     * Respond with success
+     */
+    void success();
+
+    /**
+     * Respond with failure
+     * @param status The ATT status (error code)
+     */
+    void failure(int status);
+
+    /**
+     * Trigger a disconnection
+     * @param status The disconnection status (error code)
+     */
+    void disconnect(int status);
+}

mockrxandroidble/src/main/java/com/polidea/rxandroidble2/mockrxandroidble/Callbacks/RxBleCharacteristicReadCallback.java

@@ -0,0 +1,21 @@
+package com.polidea.rxandroidble2.mockrxandroidble.Callbacks;
+
+import android.bluetooth.BluetoothGattCharacteristic;
+
+import com.polidea.rxandroidble2.mockrxandroidble.Callbacks.Results.RxBleGattReadResultMock;
+import com.polidea.rxandroidble2.mockrxandroidble.RxBleDeviceMock;
+
+/**
+ * An interface for a user callback for handling characteristic read requests
+ */
+public interface RxBleCharacteristicReadCallback {
+
+    /**
+     * Handles a read on a GATT characteristic
+     * @param device the device being read from
+     * @param characteristic the characteristic being read from
+     * @param result the result handler
+     * @throws Exception on error
+     */
+    void handle(RxBleDeviceMock device, BluetoothGattCharacteristic characteristic, RxBleGattReadResultMock result) throws Exception;
+}

mockrxandroidble/src/main/java/com/polidea/rxandroidble2/mockrxandroidble/Callbacks/RxBleCharacteristicWriteCallback.java

@@ -0,0 +1,25 @@
+package com.polidea.rxandroidble2.mockrxandroidble.Callbacks;
+
+import android.bluetooth.BluetoothGattCharacteristic;
+
+import com.polidea.rxandroidble2.mockrxandroidble.Callbacks.Results.RxBleGattWriteResultMock;
+import com.polidea.rxandroidble2.mockrxandroidble.RxBleDeviceMock;
+
+/**
+ * An interface for a user callback for handling characteristic write requests
+ */
+public interface RxBleCharacteristicWriteCallback {
+
+    /**
+     * Handles a write on a GATT characteristic
+     * @param device the device being written to
+     * @param characteristic the characteristic being written to
+     * @param data the data being written
+     * @param result the result handler
+     * @throws Exception on error
+     */
+    void handle(RxBleDeviceMock device,
+                BluetoothGattCharacteristic characteristic,
+                byte[] data,
+                RxBleGattWriteResultMock result) throws Exception;
+}

mockrxandroidble/src/main/java/com/polidea/rxandroidble2/mockrxandroidble/Callbacks/RxBleDescriptorReadCallback.java

@@ -0,0 +1,21 @@
+package com.polidea.rxandroidble2.mockrxandroidble.Callbacks;
+
+import android.bluetooth.BluetoothGattDescriptor;
+
+import com.polidea.rxandroidble2.mockrxandroidble.Callbacks.Results.RxBleGattReadResultMock;
+import com.polidea.rxandroidble2.mockrxandroidble.RxBleDeviceMock;
+
+/**
+ * An interface for a user callback for handling descriptor read requests
+ */
+public interface RxBleDescriptorReadCallback {
+
+    /**
+     * Handles a read on a GATT descriptor
+     * @param device the device being read from
+     * @param descriptor the descriptor being read from
+     * @param result the result handler
+     * @throws Exception on error
+     */
+    void handle(RxBleDeviceMock device, BluetoothGattDescriptor descriptor, RxBleGattReadResultMock result) throws Exception;
+}

mockrxandroidble/src/main/java/com/polidea/rxandroidble2/mockrxandroidble/Callbacks/RxBleDescriptorWriteCallback.java

@@ -0,0 +1,22 @@
+package com.polidea.rxandroidble2.mockrxandroidble.Callbacks;
+
+import android.bluetooth.BluetoothGattDescriptor;
+
+import com.polidea.rxandroidble2.mockrxandroidble.Callbacks.Results.RxBleGattWriteResultMock;
+import com.polidea.rxandroidble2.mockrxandroidble.RxBleDeviceMock;
+
+/**
+ * An interface for a user callback for handling descriptor write requests
+ */
+public interface RxBleDescriptorWriteCallback {
+
+    /**
+     * Handles a write on a GATT descriptor
+     * @param device the device being written to
+     * @param descriptor the descriptor being written to
+     * @param data the data being written
+     * @param result the result handler
+     * @throws Exception on error
+     */
+    void handle(RxBleDeviceMock device, BluetoothGattDescriptor descriptor, byte[] data, RxBleGattWriteResultMock result) throws Exception;
+}

mockrxandroidble/src/main/java/com/polidea/rxandroidble2/mockrxandroidble/RxBleClientMock.java

@@ -102,6 +102,49 @@ public CharacteristicsBuilder() {
             this.bluetoothGattCharacteristics = new ArrayList<>();
         }
 
+        /**
+         * Adds a {@link BluetoothGattCharacteristic}
+         *
+         * @param characteristic        The characteristic to add
+         */
+        public CharacteristicsBuilder addCharacteristic(BluetoothGattCharacteristic characteristic) {
+            this.bluetoothGattCharacteristics.add(characteristic);
+            return this;
+        }
+
+        /**
+         * Adds a {@link BluetoothGattCharacteristic} with specified parameters.
+         *
+         * @param uuid        characteristic UUID
+         * @param data        locally stored value of the characteristic
+         * @param properties  OR-ed {@link BluetoothGattCharacteristic} property constants
+         * @param descriptors list of characteristic descriptors. Use {@link DescriptorsBuilder} to create them.
+         */
+        public CharacteristicsBuilder addCharacteristic(@NonNull UUID uuid,
+                                                        @NonNull byte[] data,
+                                                        int properties,
+                                                        List<BluetoothGattDescriptor> descriptors) {
+            BluetoothGattCharacteristic characteristic = new BluetoothGattCharacteristic(uuid, properties, 0);
+            for (BluetoothGattDescriptor descriptor : descriptors) {
+                characteristic.addDescriptor(descriptor);
+            }
+            characteristic.setValue(data);
+            return addCharacteristic(characteristic);
+        }
+
+        /**
+         * Adds a {@link BluetoothGattCharacteristic} with specified parameters.
+         *
+         * @param uuid        characteristic UUID
+         * @param data        locally stored value of the characteristic
+         * @param properties  OR-ed {@link BluetoothGattCharacteristic} property constants
+         */
+        public CharacteristicsBuilder addCharacteristic(@NonNull UUID uuid,
+                                                        @NonNull byte[] data,
+                                                        int properties) {
+            return addCharacteristic(uuid, data, properties, new ArrayList<BluetoothGattDescriptor>());
+        }
+
         /**
          * Adds a {@link BluetoothGattCharacteristic} with specified parameters.
          *
@@ -115,6 +158,19 @@ public CharacteristicsBuilder addCharacteristic(@NonNull UUID uuid,
             return addCharacteristic(uuid, data, 0, descriptors);
         }
 
+        /**
+         * Adds a {@link BluetoothGattCharacteristic} with specified parameters.
+         *
+         * @param uuid        characteristic UUID
+         * @param data        locally stored value of the characteristic
+         * @param descriptors list of characteristic descriptors. Use {@link DescriptorsBuilder} to create them.
+         */
+        public CharacteristicsBuilder addCharacteristic(@NonNull UUID uuid,
+                                                        @NonNull byte[] data,
+                                                        BluetoothGattDescriptor... descriptors) {
+            return addCharacteristic(uuid, data, 0, descriptors);
+        }
+
         /**
          * Adds a {@link BluetoothGattCharacteristic} with specified parameters.
          *
@@ -126,14 +182,19 @@ public CharacteristicsBuilder addCharacteristic(@NonNull UUID uuid,
         public CharacteristicsBuilder addCharacteristic(@NonNull UUID uuid,
                                                         @NonNull byte[] data,
                                                         int properties,
-                                                        List<BluetoothGattDescriptor> descriptors) {
-            BluetoothGattCharacteristic characteristic = new BluetoothGattCharacteristic(uuid, properties, 0);
-            for (BluetoothGattDescriptor descriptor : descriptors) {
-                characteristic.addDescriptor(descriptor);
-            }
-            characteristic.setValue(data);
-            this.bluetoothGattCharacteristics.add(characteristic);
-            return this;
+                                                        BluetoothGattDescriptor... descriptors) {
+            return addCharacteristic(uuid, data, properties, Arrays.asList(descriptors));
+        }
+
+        /**
+         * Adds a {@link BluetoothGattCharacteristic} with specified parameters.
+         *
+         * @param uuid        characteristic UUID
+         * @param data        locally stored value of the characteristic
+         */
+        public CharacteristicsBuilder addCharacteristic(@NonNull UUID uuid,
+                                                        @NonNull byte[] data) {
+            return addCharacteristic(uuid, data, 0);
         }
 
         /**
@@ -156,6 +217,16 @@ public DescriptorsBuilder() {
             this.bluetoothGattDescriptors = new ArrayList<>();
         }
 
+        /**
+         * Adds a {@link BluetoothGattDescriptor}.
+         *
+         * @param descriptor the descriptor
+         */
+        public DescriptorsBuilder addDescriptor(@NonNull BluetoothGattDescriptor descriptor) {
+            bluetoothGattDescriptors.add(descriptor);
+            return this;
+        }
+
         /**
          * Adds a {@link BluetoothGattDescriptor} with specified parameters.
          *
@@ -165,8 +236,7 @@ public DescriptorsBuilder() {
         public DescriptorsBuilder addDescriptor(@NonNull UUID uuid, @NonNull byte[] data) {
             BluetoothGattDescriptor bluetoothGattDescriptor = new BluetoothGattDescriptor(uuid, 0);
             bluetoothGattDescriptor.setValue(data);
-            bluetoothGattDescriptors.add(bluetoothGattDescriptor);
-            return this;
+            return addDescriptor(bluetoothGattDescriptor);
         }
 
         /**