Added getPermissionSubscriptionState and observer removers

Author: jkasten2

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSObservable.java

@@ -51,6 +51,16 @@ void addObserverStrong(ObserverType observer){
       observers.add(observer);
    }
 
+   void removeObserver(ObserverType observer) {
+      for(int i = 0; i < observers.size(); i++) {
+         Object anObserver = ((WeakReference)observers.get(i)).get();
+         if (anObserver.equals(observer)) {
+            observers.remove(i);
+            break;
+         }
+      }
+   }
+   
    boolean notifyChange(final StateType state) {
       boolean notified = false;
 

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSPermissionStateChanges.java

@@ -28,5 +28,13 @@
 package com.onesignal;
 
 public class OSPermissionStateChanges {
-   public OSPermissionState to, from;
+   OSPermissionState to, from;
+   
+   public OSPermissionState getTo() {
+      return to;
+   }
+   
+   public OSPermissionState getFrom() {
+      return from;
+   }
 }

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSPermissionSubscriptionState.java

@@ -0,0 +1,14 @@
+package com.onesignal;
+
+public class OSPermissionSubscriptionState {
+   OSSubscriptionState subscriptionStatus;
+   OSPermissionState permissionStatus;
+   
+   public OSPermissionState getPermissionStatus() {
+      return permissionStatus;
+   }
+   
+   public OSSubscriptionState getSubscriptionStatus() {
+      return subscriptionStatus;
+   }
+}

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSSubscriptionStateChanges.java

@@ -28,5 +28,13 @@
 package com.onesignal;
 
 public class OSSubscriptionStateChanges {
-   public OSSubscriptionState to, from;
+   OSSubscriptionState to, from;
+   
+   public OSSubscriptionState getTo() {
+      return to;
+   }
+   
+   public OSSubscriptionState getFrom() {
+      return from;
+   }
 }

OneSignalSDK/onesignal/src/main/java/com/onesignal/OneSignal.java

@@ -1498,6 +1498,15 @@ public static void addPermissionObserver(OSPermissionObserver observer) {
          OSPermissionChangedInternalObserver.fireChangesToPublicObserver(getCurrentPermissionState(appContext));
    }
 
+   public static void removePermissionObserver(OSPermissionObserver observer) {
+      if (appContext == null) {
+         Log(LOG_LEVEL.ERROR, "OneSignal.init has not been called. Could not modify permission observer");
+         return;
+      }
+   
+      getPermissionStateChangesObserver().removeObserver(observer);
+   }
+   
    public static void addSubscriptionObserver(OSSubscriptionObserver observer) {
       if (appContext == null) {
          Log(LOG_LEVEL.ERROR, "OneSignal.init has not been called. Could not add subscription observer");
@@ -1509,6 +1518,28 @@ public static void addSubscriptionObserver(OSSubscriptionObserver observer) {
       if (getCurrentSubscriptionState(appContext).compare(getLastSubscriptionState(appContext)))
          OSSubscriptionChangedInternalObserver.fireChangesToPublicObserver(getCurrentSubscriptionState(appContext));
    }
+   
+   public static void removeSubscriptionObserver(OSSubscriptionObserver observer) {
+      if (appContext == null) {
+         Log(LOG_LEVEL.ERROR, "OneSignal.init has not been called. Could not modify subscription observer");
+         return;
+      }
+      
+      getSubscriptionStateChangesObserver().removeObserver(observer);
+   }
+   
+   public static OSPermissionSubscriptionState getPermissionSubscriptionState() {
+      if (appContext == null) {
+         Log(LOG_LEVEL.ERROR, "OneSignal.init has not been called. Could not get OSPermissionSubscriptionState");
+         return null;
+      }
+      
+      OSPermissionSubscriptionState status = new OSPermissionSubscriptionState();
+      status.subscriptionStatus = getCurrentSubscriptionState(appContext);
+      status.permissionStatus = getCurrentPermissionState(appContext);
+   
+      return status;
+   }
 
    static long GetUnsentActiveTime() {
       if (unSentActiveTime == -1 && appContext != null) {

OneSignalSDK/unittest/src/test/java/com/test/onesignal/MainOneSignalClassRunner.java

@@ -48,6 +48,7 @@
 import com.onesignal.OSNotificationPayload;
 import com.onesignal.OSPermissionObserver;
 import com.onesignal.OSPermissionStateChanges;
+import com.onesignal.OSPermissionSubscriptionState;
 import com.onesignal.OSSubscriptionObserver;
 import com.onesignal.OSSubscriptionStateChanges;
 import com.onesignal.OneSignal;
@@ -1620,13 +1621,13 @@ public void shouldFirePermissionObserverOnFirstAdd() throws Exception {
          @Override
          public void onOSPermissionChanged(OSPermissionStateChanges stateChanges) {
             lastPermissionStateChanges = stateChanges;
-            currentPermission = stateChanges.to.getEnabled();
+            currentPermission = stateChanges.getTo().getEnabled();
          }
       };
       OneSignal.addPermissionObserver(permissionObserver);
 
-      Assert.assertFalse(lastPermissionStateChanges.from.getEnabled());
-      Assert.assertTrue(lastPermissionStateChanges.to.getEnabled());
+      Assert.assertFalse(lastPermissionStateChanges.getFrom().getEnabled());
+      Assert.assertTrue(lastPermissionStateChanges.getTo().getEnabled());
       // Test to make sure object was correct at the time of firing.
       Assert.assertTrue(currentPermission);
    }
@@ -1640,7 +1641,7 @@ public void shouldFirePermissionObserverWhenUserDisablesNotifications() throws E
          @Override
          public void onOSPermissionChanged(OSPermissionStateChanges stateChanges) {
             lastPermissionStateChanges = stateChanges;
-            currentPermission = stateChanges.to.getEnabled();
+            currentPermission = stateChanges.getTo().getEnabled();
          }
       };
       OneSignal.addPermissionObserver(permissionObserver);
@@ -1654,8 +1655,8 @@ public void onOSPermissionChanged(OSPermissionStateChanges stateChanges) {
       blankActivityController.resume();
       threadAndTaskWait();
 
-      Assert.assertTrue(lastPermissionStateChanges.from.getEnabled());
-      Assert.assertFalse(lastPermissionStateChanges.to.getEnabled());
+      Assert.assertTrue(lastPermissionStateChanges.getFrom().getEnabled());
+      Assert.assertFalse(lastPermissionStateChanges.getTo().getEnabled());
       // Test to make sure object was correct at the time of firing.
       Assert.assertFalse(currentPermission);
       // unsubscribeWhenNotificationsAreDisabled is not set so don't send notification_types.
@@ -1707,13 +1708,13 @@ public void shouldFireSubscriptionObserverOnFirstAdd() throws Exception {
          @Override
          public void onOSSubscriptionChanged(OSSubscriptionStateChanges stateChanges) {
             lastSubscriptionStateChanges = stateChanges;
-            currentSubscription = stateChanges.to.getSubscribed();
+            currentSubscription = stateChanges.getTo().getSubscribed();
          }
       };
       OneSignal.addSubscriptionObserver(permissionObserver);
 
-      Assert.assertFalse(lastSubscriptionStateChanges.from.getSubscribed());
-      Assert.assertTrue(lastSubscriptionStateChanges.to.getSubscribed());
+      Assert.assertFalse(lastSubscriptionStateChanges.getFrom().getSubscribed());
+      Assert.assertTrue(lastSubscriptionStateChanges.getTo().getSubscribed());
       // Test to make sure object was correct at the time of firing.
       Assert.assertTrue(currentSubscription);
    }
@@ -1727,7 +1728,7 @@ public void shouldFireSubscriptionObserverWhenUserDisablesNotifications() throws
          @Override
          public void onOSSubscriptionChanged(OSSubscriptionStateChanges stateChanges) {
             lastSubscriptionStateChanges = stateChanges;
-            currentSubscription = stateChanges.to.getSubscribed();
+            currentSubscription = stateChanges.getTo().getSubscribed();
          }
       };
       OneSignal.addSubscriptionObserver(subscriptionObserver);
@@ -1741,8 +1742,8 @@ public void onOSSubscriptionChanged(OSSubscriptionStateChanges stateChanges) {
       blankActivityController.resume();
       threadAndTaskWait();
 
-      Assert.assertTrue(lastSubscriptionStateChanges.from.getSubscribed());
-      Assert.assertFalse(lastSubscriptionStateChanges.to.getSubscribed());
+      Assert.assertTrue(lastSubscriptionStateChanges.getFrom().getSubscribed());
+      Assert.assertFalse(lastSubscriptionStateChanges.getTo().getSubscribed());
       // Test to make sure object was correct at the time of firing.
       Assert.assertFalse(currentSubscription);
       // unsubscribeWhenNotificationsAreDisabled is not set so don't send notification_types.
@@ -1756,21 +1757,48 @@ public void shouldFireSubscriptionObserverWhenChangesHappen() throws Exception {
          @Override
          public void onOSSubscriptionChanged(OSSubscriptionStateChanges stateChanges) {
             lastSubscriptionStateChanges = stateChanges;
-            currentSubscription = stateChanges.to.getSubscribed();
+            currentSubscription = stateChanges.getTo().getSubscribed();
          }
       };
       OneSignal.addSubscriptionObserver(permissionObserver);
       threadAndTaskWait();
 
-      Assert.assertFalse(lastSubscriptionStateChanges.from.getSubscribed());
-      Assert.assertTrue(lastSubscriptionStateChanges.to.getSubscribed());
+      Assert.assertFalse(lastSubscriptionStateChanges.getFrom().getSubscribed());
+      Assert.assertTrue(lastSubscriptionStateChanges.getTo().getSubscribed());
       // Test to make sure object was correct at the time of firing.
       Assert.assertTrue(currentSubscription);
-      Assert.assertTrue(lastSubscriptionStateChanges.to.getUserSubscriptionSetting());
-      Assert.assertEquals(ShadowPushRegistratorGPS.regId, lastSubscriptionStateChanges.to.getPushToken());
-      Assert.assertEquals(ShadowOneSignalRestClient.testUserId, lastSubscriptionStateChanges.to.getUserId());
+      Assert.assertTrue(lastSubscriptionStateChanges.getTo().getUserSubscriptionSetting());
+      Assert.assertEquals(ShadowPushRegistratorGPS.regId, lastSubscriptionStateChanges.getTo().getPushToken());
+      Assert.assertEquals(ShadowOneSignalRestClient.testUserId, lastSubscriptionStateChanges.getTo().getUserId());
    }
 
+   @Test
+   public void shouldNotFireSubscriptionObserverWhenChangesHappenIfRemoved() throws Exception {
+      OneSignalInit();
+      OSSubscriptionObserver permissionObserver = new OSSubscriptionObserver() {
+         @Override
+         public void onOSSubscriptionChanged(OSSubscriptionStateChanges stateChanges) {
+            lastSubscriptionStateChanges = stateChanges;
+            currentSubscription = stateChanges.getTo().getSubscribed();
+         }
+      };
+      OneSignal.addSubscriptionObserver(permissionObserver);
+      lastSubscriptionStateChanges = null;
+      OneSignal.removeSubscriptionObserver(permissionObserver);
+      threadAndTaskWait();
+      
+      Assert.assertFalse(currentSubscription);
+      Assert.assertNull(lastSubscriptionStateChanges);
+   }
+   
+   @Test
+   public void shouldReturnCorrectGetPermissionSubscriptionState() throws Exception {
+      OneSignalInit();
+      threadAndTaskWait();
+      OSPermissionSubscriptionState permissionSubscriptionState = OneSignal.getPermissionSubscriptionState();
+      Assert.assertTrue(permissionSubscriptionState.getPermissionStatus().getEnabled());
+      Assert.assertTrue(permissionSubscriptionState.getSubscriptionStatus().getSubscribed());
+   }
 
    // ####### Unit test helper methods ########