Merge pull request #936 from firebase/firestore

Firestore

Author: samtstern

README.md

@@ -3,8 +3,7 @@
 [![Build Status](https://travis-ci.org/firebase/FirebaseUI-Android.svg?branch=master)](https://travis-ci.org/firebase/FirebaseUI-Android)
 
 FirebaseUI is an open-source library for Android that allows you to
-quickly connect common UI elements to [Firebase](https://firebase.google.com)
-APIs like the Realtime Database or Firebase Authentication.
+quickly connect common UI elements to [Firebase](https://firebase.google.com) APIs.
 
 A compatible FirebaseUI client is also available for [iOS](https://github.com/firebase/firebaseui-ios).
 
@@ -19,10 +18,11 @@ A compatible FirebaseUI client is also available for [iOS](https://github.com/fi
 
 ## Usage
 
-FirebaseUI has separate modules for using Firebase Database, Auth, and Storage. To
-get started, see the individual instructions for each module:
+FirebaseUI has separate modules for using Firebase Realtime Database, Cloud Firestore, 
+Firebase Auth, and Cloud Storage. To get started, see the individual instructions for each module:
 
   * [firebase-ui-database](database/README.md)
+  * [firebase-ui-firestore](firestore/README.md)
   * [firebase-ui-auth](auth/README.md)
   * [firebase-ui-storage](storage/README.md)
 
@@ -38,17 +38,17 @@ libraries.
 
 ```groovy
 dependencies {
-    // FirebaseUI Database only
+    // FirebaseUI for Firebase Realtime Database
     compile 'com.firebaseui:firebase-ui-database:2.4.0'
+    
+    // FirebaseUI for Cloud Firestore
+    compile 'com.firebaseui:firebase-ui-firestore:2.4.0'
 
-    // FirebaseUI Auth only
+    // FirebaseUI for Firebase Auth
     compile 'com.firebaseui:firebase-ui-auth:2.4.0'
 
-    // FirebaseUI Storage only
+    // FirebaseUI for Cloud Storage
     compile 'com.firebaseui:firebase-ui-storage:2.4.0'
-
-    // Single target that includes all FirebaseUI libraries above
-    compile 'com.firebaseui:firebase-ui:2.4.0'
 }
 ```
 
@@ -63,6 +63,7 @@ After the project is synchronized, we're ready to start using Firebase functiona
 If you are using an old version of FirebaseUI and upgrading, please see the appropriate
 migration guide:
 
+  * [Upgrade from 2.3.0 to 3.x.x](./docs/upgrade-to-3.0.md)
   * [Upgrade from 1.2.0 to 2.x.x](./docs/upgrade-to-2.0.md)
 
 ## Dependencies
@@ -78,6 +79,9 @@ firebase-ui-auth
 firebase-ui-database
 |--- com.google.firebase:firebase-database
 
+firebase-ui-firestore
+|--- com.google.firebase:firebase-firestore
+
 firebase-ui-storage
 |--- com.google.firebase:firebase-storage
 ```
@@ -121,7 +125,7 @@ compile "com.android.support:customtabs:$BAR"
 compile "com.android.support:cardview-v7:$BAR"
 ```
 
-Database:
+Realtime Database:
 
 ```groovy
 compile "com.google.firebase:firebase-database:$FOO"
@@ -130,6 +134,15 @@ compile "com.android.support:recyclerview-v7:$BAR"
 compile "com.android.support:support-v4:$BAR"
 ```
 
+Firestore:
+
+```groovy
+compile "com.google.firebase:firebase-firestore:$FOO"
+
+compile "com.android.support:recyclerview-v7:$BAR"
+compile "com.android.support:support-v4:$BAR"
+```
+
 Storage:
 
 ```groovy

app/build.gradle

@@ -13,6 +13,7 @@ android {
         versionName "1.0"
 
         vectorDrawables.useSupportLibrary = true
+        multiDexEnabled true
     }
 
     buildTypes {
@@ -34,9 +35,11 @@ android {
 dependencies {
     compile fileTree(dir: 'libs', include: ['*.jar'])
     compile "com.android.support:design:$supportLibraryVersion"
+    compile 'com.android.support:multidex:1.0.1'
 
     compile project(path: ':auth')
     compile project(path: ':database')
+    compile project(path: ':firestore')
     compile project(path: ':storage')
 
     compile "com.google.android.gms:play-services-auth:$firebaseVersion"
@@ -47,6 +50,9 @@ dependencies {
     compile('com.facebook.android:facebook-login:4.27.0')
     compile("com.twitter.sdk.android:twitter-core:3.0.0@aar") { transitive = true }
 
+    compile "android.arch.lifecycle:runtime:$architectureVersion"
+    compile "android.arch.lifecycle:extensions:$architectureVersion"
+
     compile 'com.github.bumptech.glide:glide:4.1.1'
     annotationProcessor 'com.github.bumptech.glide:compiler:4.1.1'
 

app/src/main/AndroidManifest.xml

@@ -38,6 +38,11 @@
             android:name=".auth.SignedInActivity"
             android:label="@string/title_auth_activity" />
 
+        <!-- Firestore demo -->
+        <activity
+            android:name=".database.firestore.FirestoreChatActivity"
+            android:label="@string/title_firestore_activity" />
+
         <!-- Realtime database demo -->
         <activity
             android:name=".database.realtime.RealtimeDbChatActivity"

app/src/main/java/com/firebase/uidemo/ChooserActivity.java

@@ -26,6 +26,7 @@
 import android.widget.TextView;
 
 import com.firebase.uidemo.auth.AuthUiActivity;
+import com.firebase.uidemo.database.firestore.FirestoreChatActivity;
 import com.firebase.uidemo.database.realtime.RealtimeDbChatActivity;
 import com.firebase.uidemo.storage.ImageActivity;
 
@@ -50,18 +51,21 @@ protected void onCreate(Bundle savedInstanceState) {
     private static class ActivityChooserAdapter extends RecyclerView.Adapter<ActivityStarterHolder> {
         private static final Class[] CLASSES = new Class[]{
                 AuthUiActivity.class,
+                FirestoreChatActivity.class,
                 RealtimeDbChatActivity.class,
                 ImageActivity.class,
         };
 
         private static final int[] DESCRIPTION_NAMES = new int[]{
                 R.string.title_auth_activity,
+                R.string.title_firestore_activity,
                 R.string.title_realtime_database_activity,
                 R.string.title_storage_activity
         };
 
         private static final int[] DESCRIPTION_IDS = new int[]{
                 R.string.desc_auth,
+                R.string.desc_firestore,
                 R.string.desc_realtime_database,
                 R.string.desc_storage
         };

app/src/main/java/com/firebase/uidemo/auth/FirebaseUIDemo.java

@@ -1,13 +1,13 @@
 package com.firebase.uidemo.auth;
 
-import android.app.Application;
 import android.content.Context;
+import android.support.multidex.MultiDexApplication;
 import android.support.v7.app.AppCompatDelegate;
 
 import com.squareup.leakcanary.LeakCanary;
 import com.squareup.leakcanary.RefWatcher;
 
-public class FirebaseUIDemo extends Application {
+public class FirebaseUIDemo extends MultiDexApplication {
     private RefWatcher mRefWatcher;
 
     static {

app/src/main/java/com/firebase/uidemo/auth/SignedInActivity.java

@@ -69,7 +69,6 @@ public class SignedInActivity extends AppCompatActivity {
     @BindView(R.id.user_display_name)
     TextView mUserDisplayName;
 
-
     @BindView(R.id.user_phone_number)
     TextView mUserPhoneNumber;
 

app/src/main/java/com/firebase/uidemo/database/AbstractChat.java

@@ -0,0 +1,14 @@
+package com.firebase.uidemo.database;
+
+/**
+ * Common interface for chat messages, helps share code between RTDB and Firestore examples.
+ */
+public abstract class AbstractChat {
+
+    public abstract String getName();
+
+    public abstract String getMessage();
+
+    public abstract String getUid();
+
+}

app/src/main/java/com/firebase/uidemo/database/ChatHolder.java

@@ -28,17 +28,17 @@ public class ChatHolder extends RecyclerView.ViewHolder {
 
     public ChatHolder(View itemView) {
         super(itemView);
-        mNameField = (TextView) itemView.findViewById(R.id.name_text);
-        mTextField = (TextView) itemView.findViewById(R.id.message_text);
-        mLeftArrow = (FrameLayout) itemView.findViewById(R.id.left_arrow);
-        mRightArrow = (FrameLayout) itemView.findViewById(R.id.right_arrow);
-        mMessageContainer = (RelativeLayout) itemView.findViewById(R.id.message_container);
-        mMessage = (LinearLayout) itemView.findViewById(R.id.message);
+        mNameField = itemView.findViewById(R.id.name_text);
+        mTextField = itemView.findViewById(R.id.message_text);
+        mLeftArrow = itemView.findViewById(R.id.left_arrow);
+        mRightArrow = itemView.findViewById(R.id.right_arrow);
+        mMessageContainer = itemView.findViewById(R.id.message_container);
+        mMessage = itemView.findViewById(R.id.message);
         mGreen300 = ContextCompat.getColor(itemView.getContext(), R.color.material_green_300);
         mGray300 = ContextCompat.getColor(itemView.getContext(), R.color.material_gray_300);
     }
 
-    public void bind(Chat chat) {
+    public void bind(AbstractChat chat) {
         setName(chat.getName());
         setText(chat.getMessage());
 

app/src/main/java/com/firebase/uidemo/database/firestore/Chat.java

@@ -0,0 +1,59 @@
+package com.firebase.uidemo.database.firestore;
+
+import com.firebase.uidemo.database.AbstractChat;
+import com.google.firebase.firestore.IgnoreExtraProperties;
+import com.google.firebase.firestore.ServerTimestamp;
+
+import java.util.Date;
+
+@IgnoreExtraProperties
+public class Chat extends AbstractChat {
+
+    private String mName;
+    private String mMessage;
+    private String mUid;
+    private Date mTimestamp;
+
+    public Chat() {
+        // Needed for Firebase
+    }
+
+    public Chat(String name, String message, String uid) {
+        mName = name;
+        mMessage = message;
+        mUid = uid;
+    }
+
+    public String getName() {
+        return mName;
+    }
+
+    public void setName(String name) {
+        mName = name;
+    }
+
+    public String getMessage() {
+        return mMessage;
+    }
+
+    public void setMessage(String message) {
+        mMessage = message;
+    }
+
+    public String getUid() {
+        return mUid;
+    }
+
+    public void setUid(String uid) {
+        mUid = uid;
+    }
+
+    @ServerTimestamp
+    public Date getTimestamp() {
+        return mTimestamp;
+    }
+
+    public void setTimestamp(Date timestamp) {
+        mTimestamp = timestamp;
+    }
+}