Initial FCM setup

Author: Jawnnypoo

fcm/.gitignore

@@ -0,0 +1 @@
+/build

fcm/README.md

@@ -0,0 +1,27 @@
+# Parse SDK Android FCM
+FCM support for Parse Android apps
+
+## Setup
+
+### Installation
+
+Add dependency to the application level `build.gradle` file.
+
+```groovy
+dependencies {
+    implementation 'com.parse:parse-android:latest.version.here'
+    implementation 'com.parse:parse-android-fcm:latest.version.here'
+}
+```
+Then, follow Google's docs for [setting up an FCM app](https://firebase.google.com/docs/cloud-messaging/android/client).
+
+## Note
+If you need access to the FCM token, instead of creating a service that extends `FirebaseInstanceIdService`, extend `ParseFirebaseInstanceIDService` to assure the token still gets saved properly within Parse.
+
+## License
+    Copyright (c) 2015-present, Parse, LLC.
+    All rights reserved.
+
+    This source code is licensed under the BSD-style license found in the
+    LICENSE file in the root directory of this source tree. An additional grant
+    of patent rights can be found in the PATENTS file in the same directory.

fcm/build.gradle

@@ -0,0 +1,29 @@
+apply plugin: 'com.android.library'
+
+android {
+    compileSdkVersion rootProject.ext.compileSdkVersion
+
+    defaultConfig {
+        minSdkVersion rootProject.ext.minSdkVersion
+        targetSdkVersion rootProject.ext.targetSdkVersion
+        versionCode 1
+        versionName project.version
+
+        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
+
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+
+}
+
+dependencies {
+    implementation project(':Parse')
+    api 'com.google.firebase:firebase-messaging:12.0.1'
+    api 'com.firebase:firebase-jobdispatcher:0.8.5'
+}

fcm/proguard-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

fcm/src/main/AndroidManifest.xml

@@ -0,0 +1,17 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.parse.fcm">
+
+    <application>
+
+        <service
+            android:name=".ParseFirebaseJobService"
+            android:exported="false">
+            <intent-filter>
+                <action android:name="com.firebase.jobdispatcher.ACTION_EXECUTE" />
+            </intent-filter>
+        </service>
+
+    </application>
+
+
+</manifest>

fcm/src/main/java/com/parse/ParseFCMParseAccess.java

@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) 2015-present, Parse, LLC.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+package com.parse;
+
+/**
+ * shhh don't talk about this
+ */
+public class ParseFCMParseAccess {
+
+    public static void setToken(ParseInstallation installation, String token) {
+        installation.setDeviceToken(token);
+        //Yes, we are actually FCM, but its the same for our purposes
+        installation.setPushType(PushType.GCM);
+    }
+}

fcm/src/main/java/com/parse/fcm/ParseFirebaseInstanceIDService.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2015-present, Parse, LLC.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+package com.parse.fcm;
+
+import android.support.annotation.CallSuper;
+
+import com.firebase.jobdispatcher.Constraint;
+import com.firebase.jobdispatcher.FirebaseJobDispatcher;
+import com.firebase.jobdispatcher.GooglePlayDriver;
+import com.firebase.jobdispatcher.Job;
+import com.firebase.jobdispatcher.RetryStrategy;
+import com.google.firebase.iid.FirebaseInstanceIdService;
+import com.parse.ParseInstallation;
+
+/**
+ * Assures the {@link ParseInstallation#getDeviceToken()} stays up to date. If you need to do custom things with the token, make sure you extend this
+ * class and call super.
+ */
+public class ParseFirebaseInstanceIDService extends FirebaseInstanceIdService {
+
+    @CallSuper
+    @Override
+    public void onTokenRefresh() {
+        super.onTokenRefresh();
+        FirebaseJobDispatcher dispatcher = new FirebaseJobDispatcher(new GooglePlayDriver(getApplicationContext()));
+        Job job = dispatcher.newJobBuilder()
+                .setRecurring(false)
+                .setReplaceCurrent(true)
+                // retry with exponential backoff
+                .setRetryStrategy(RetryStrategy.DEFAULT_EXPONENTIAL)
+                .setConstraints(
+                        // only run on a network
+                        Constraint.ON_ANY_NETWORK
+                )
+                .setService(ParseFirebaseJobService.class) // the JobService that will be called
+                .setTag("upload-token")        // uniquely identifies the job
+                .build();
+
+        dispatcher.mustSchedule(job);
+    }
+}

fcm/src/main/java/com/parse/fcm/ParseFirebaseJobService.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2015-present, Parse, LLC.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+package com.parse.fcm;
+
+import com.firebase.jobdispatcher.JobParameters;
+import com.firebase.jobdispatcher.JobService;
+import com.google.firebase.iid.FirebaseInstanceId;
+import com.parse.ParseException;
+import com.parse.ParseInstallation;
+import com.parse.SaveCallback;
+import com.parse.ParseFCMParseAccess;
+
+/**
+ * Handles saving the FCM token to the {@link ParseInstallation}
+ */
+public class ParseFirebaseJobService extends JobService {
+
+    @Override
+    public boolean onStartJob(final JobParameters job) {
+        ParseInstallation installation = ParseInstallation.getCurrentInstallation();
+        String token = FirebaseInstanceId.getInstance().getToken();
+        if (installation != null && token != null) {
+            ParseFCMParseAccess.setToken(installation, token);
+            installation.saveInBackground(new SaveCallback() {
+                @Override
+                public void done(ParseException e) {
+                    if (e == null) {
+                        jobFinished(job, false);
+                    } else {
+                        jobFinished(job, true);
+                    }
+                }
+            });
+            return true;
+        }
+        return false; // Answers the question: "Is there still work going on?"
+    }
+
+    @Override
+    public boolean onStopJob(JobParameters job) {
+        return true; // Answers the question: "Should this job be retried?"
+    }
+}

settings.gradle

@@ -1,2 +1,2 @@
-include ':Parse'
+include ':Parse', ':fcm'