Fixed GCM.unregister() and GCM.MESSAGE_TYPE_MESSAGE deprecations.

Author: rion18

CHANGELOG.MD

@@ -1,5 +1,10 @@
 # Change Log
 
+## [1.1.0](https://github.com/devsu/gcm-push-client/releases/tag/1.1.0) (2015-12-22)
+
++ Fixed GCM.unregister() method deprecation by creating an UnregisterService.
++ Fixed GCM.MESSAGE_TYPE_MESSAGE constant deprecation by creating a class that extends GcmListenerService.
+
 ## [1.0.0](https://github.com/devsu/gcm-push-client/releases/tag/1.0.0) (2015-12-22)
 
 First release of the GCM Push Client.

pushclient/build.gradle

@@ -8,7 +8,7 @@ android {
         minSdkVersion 12
         targetSdkVersion 23
         versionCode 1
-        versionName "1.0"
+        versionName "1.1.0"
     }
 
     buildTypes {
@@ -27,10 +27,10 @@ ext {
     libraryName = 'GCM Push Client'
     artifact = 'pushclient'
 
-    libraryDescription = 'Library that allows you to receive GCM Push Messages on Android.'
+    libraryDescription = 'Library that allows you to easily receive GCM Push Messages on Android.'
 
-    siteUrl = 'https://bitbucket.org/rion18/pushclient'
-    gitUrl = 'https://[email protected]/rion18/pushclient.git'
+    siteUrl = 'https://github.com/devsu/gcm-push-client'
+    gitUrl = 'https://github.com/devsu/gcm-push-client.git'
 
     libraryVersion = android.defaultConfig.versionName
 

pushclient/src/main/AndroidManifest.xml

@@ -28,7 +28,7 @@
         </receiver>
 
         <service
-            android:name=".service.PushClientIntentService"
+            android:name=".service.PushListenerService"
             android:exported="false" >
             <intent-filter>
                 <action android:name="com.google.android.c2dm.intent.RECEIVE" />
@@ -48,6 +48,11 @@
             android:exported="false">
         </service>
 
+        <service
+            android:name=".service.UnregistrationIntentService"
+            android:exported="false">
+        </service>
+
     </application>
 
 </manifest>

pushclient/src/main/java/com/devsu/library/pushclient/client/PushClient.java

@@ -18,9 +18,9 @@
 import com.devsu.library.pushclient.prefs.PrefsConstants;
 import com.devsu.library.pushclient.service.RegistrationIntentService;
 import com.devsu.library.pushclient.service.RegistrationResultReceiver;
+import com.devsu.library.pushclient.service.UnregistrationIntentService;
 import com.google.android.gms.common.ConnectionResult;
 import com.google.android.gms.common.GoogleApiAvailability;
-import com.google.android.gms.gcm.GoogleCloudMessaging;
 
 import java.io.IOException;
 
@@ -54,11 +54,6 @@ public final class PushClient implements RegistrationResultReceiver.Receiver {
      */
     private String mGcmId;
 
-    /**
-     * The GCM instance.
-     */
-    private GoogleCloudMessaging mGcm;
-
     /**
      * The retrieved registation ID.
      */
@@ -136,42 +131,61 @@ public static void initialize(Context context, String gcmId, InitCallback initCa
         sInstance.mGcmId = gcmId;
         sInstance.mInitCallback = initCallback;
         sInstance.mPushDelegate = delegate;
-        sInstance.startIntentServiceIfNeeded();
+        sInstance.startRegistrationIntentServiceIfNeeded();
     }
 
     /**
      * Launches the GCM Registration IntentService if app is not registered.
      */
-    private void startIntentServiceIfNeeded() {
+    private void startRegistrationIntentServiceIfNeeded() {
         if (!hasPlayServices()) {
             doOnCallbackError(new PlayServicesNotFoundException());
             return;
         }
-        mGcm = GoogleCloudMessaging.getInstance(mContext);
         mRegistrationId = loadRegistrationId();
         if (!TextUtils.isEmpty(mRegistrationId)) {
             doOnCallbackSuccess(false);
             return;
         }
-        startIntentService();
+        startRegistrationIntentService();
     }
 
     /**
      * Launches the GCM Registration IntentService.
      */
-    private void startIntentService() {
+    private void startRegistrationIntentService() {
         Intent intent = new Intent(mContext, RegistrationIntentService.class);
         intent.putExtra(RegistrationResultReceiver.TAG, mReceiver);
         intent.putExtra(PrefsConstants.PREF_GCM_ID, mGcmId);
         mContext.startService(intent);
     }
 
     /**
-     * Receives the GCM Registration IntentService's result.
+     * Receives any IntentService's result, and handles Registration and Unregistration events.
      * @param resultCode The IntentService's result code.
      * @param resultData The IntentService's extras.
      */
     public void onReceiveResult(int resultCode, Bundle resultData) {
+        if (resultData == null) {
+            return;
+        }
+        String origin = resultData.getString(PrefsConstants.SERVICE_ORIGIN);
+        if (origin == null) {
+            return;
+        }
+        if (origin.equals(RegistrationIntentService.class.getSimpleName())) {
+            onReceiveRegistrationResult(resultCode, resultData);
+        } else if (origin.equals(UnregistrationIntentService.class.getSimpleName())) {
+            onReceiveUnregistrationResult(resultCode, resultData);
+        }
+    }
+
+    /**
+     * Receives the GCM Registration IntentService's result.
+     * @param resultCode The IntentService's result code.
+     * @param resultData The IntentService's extras.
+     */
+    public void onReceiveRegistrationResult(int resultCode, Bundle resultData) {
         if (mReceiver != null && resultCode == Activity.RESULT_OK) {
             mRegistrationId = resultData.getString(PrefsConstants.PREF_REG_ID);
             storeRegistrationId(mRegistrationId);
@@ -180,13 +194,35 @@ public void onReceiveResult(int resultCode, Bundle resultData) {
         }
         if (mReceiver != null && resultCode == Activity.RESULT_CANCELED) {
             IOException e = (IOException) resultData.getSerializable(PrefsConstants.REGISTRATION_EXCEPTION);
-            if (e == null)
+            if (e == null) {
                 return;
+            }
             doOnCallbackError(e.getMessage().equalsIgnoreCase(INVALID_SENDER)
                     ? new InvalidSenderIdException(mGcmId) : new PushClientException(e));
         }
     }
 
+    /**
+     * Receives the GCM Unregistration IntentService's result.
+     * @param resultCode The IntentService's result code.
+     * @param resultData The IntentService's extras.
+     */
+    public void onReceiveUnregistrationResult(int resultCode, Bundle resultData) {
+        if (mReceiver != null && resultCode == Activity.RESULT_OK) {
+            sInstance.mRegistrationId = null;
+            sInstance.getPushPreferences().edit().clear().apply();
+            Log.d(TAG, "Unregistration successful.");
+            return;
+        }
+        if (mReceiver != null && resultCode == Activity.RESULT_CANCELED) {
+            IOException e = (IOException) resultData.getSerializable(PrefsConstants.REGISTRATION_EXCEPTION);
+            if (e == null) {
+                return;
+            }
+            Log.e(TAG, e.getMessage());
+        }
+    }
+
     /**
      * Executes an initialization error callback.
      * @param e The exception for the error callback.
@@ -273,15 +309,21 @@ private String loadRegistrationId() {
      * Unregisters this device from GCM.
      */
     public static void unregister() {
+        if (sInstance == null)
+            throw new RuntimeException(TAG + " has not been initialized.");
         if (sInstance.mRegistrationId == null) {
             throw new RuntimeException(TAG + " is not registered");
         }
-        try {
-            sInstance.mGcm.unregister();
-            sInstance.getPushPreferences().edit().clear().apply();
-        } catch (Exception e) {
-            throw new RuntimeException(e);
-        }
+        sInstance.startUnregistrationIntentService();
+    }
+
+    /**
+     * Launches the GCM Unregistration IntentService.
+     */
+    private void startUnregistrationIntentService() {
+        Intent intent = new Intent(mContext, UnregistrationIntentService.class);
+        intent.putExtra(RegistrationResultReceiver.TAG, mReceiver);
+        mContext.startService(intent);
     }
 
     /**
@@ -301,6 +343,14 @@ public static void setDelegate(PushDelegate pushDelegate) {
 
     }
 
+    /**
+     * Gets the GCM ID (or Sender ID)
+     * @return The GCM ID (or Sender ID)
+     */
+    public static String getGcmId() {
+        return sInstance.mGcmId;
+    }
+
     /**
      * Gets the delegate that handles the push message display.
      * @return The delegate that handles the push message display.

pushclient/src/main/java/com/devsu/library/pushclient/delegate/SimpleNotificationDelegate.java

@@ -145,7 +145,7 @@ public void handleNotification(Context context, Bundle extras) {
      * Retrieves the contentIntent for the default activity.
      * @param context The context.
      * @param currentTimeStamp The time of Notification.
-     * @return
+     * @return The content intent.
      */
     private PendingIntent getContentIntent(Context context, int currentTimeStamp) {
         Intent intent = new Intent();

pushclient/src/main/java/com/devsu/library/pushclient/prefs/PrefsConstants.java

@@ -9,4 +9,5 @@ public class PrefsConstants {
     public static final String PREF_REG_ID = "registration_id";
     public static final String PREF_GCM_ID = "gcm_id";
     public static final String REGISTRATION_EXCEPTION = "registration_exception";
+    public static final String SERVICE_ORIGIN = "service_origin";
 }

pushclient/src/main/java/com/devsu/library/pushclient/receiver/GCMBroadcastReceiver.java

@@ -0,0 +1,21 @@
+package com.devsu.library.pushclient.service;
+
+import android.os.Bundle;
+
+import com.devsu.library.pushclient.client.PushClient;
+import com.google.android.gms.gcm.GcmListenerService;
+
+/**
+ * The IntentService that processes the Push Message.
+ */
+public class PushListenerService extends GcmListenerService {
+
+    /**
+     * Retrieves the GCM Push Message.
+     */
+    @Override
+    public void onMessageReceived(String from, Bundle data) {
+        if (PushClient.getGcmId().contentEquals(from))
+            PushClient.getDelegate().handleNotification(this, data);
+    }
+}

pushclient/src/main/java/com/devsu/library/pushclient/service/PushClientIntentService.java

@@ -31,12 +31,13 @@ public RegistrationIntentService() {
 
     /**
      * Generates a new registration ID using InstanceID.
-     * @param intent The intent with the generated registration ID OR the Exception that ocurred.
+     * @param intent The intent with the Receiver tag, and GCM ID.
      */
     @Override
     public void onHandleIntent(Intent intent) {
         ResultReceiver receiver = intent.getParcelableExtra(RegistrationResultReceiver.TAG);
         Bundle bundle = new Bundle();
+        bundle.putString(PrefsConstants.SERVICE_ORIGIN, TAG);
         try {
             String gcmId = intent.getStringExtra(PrefsConstants.PREF_GCM_ID);
             InstanceID instanceID = InstanceID.getInstance(this);