Merge pull request #56 from FrangSierra/development

FrangSierra · web-flow · commit 5a974f6e505d · 2018-05-11T11:19:30.000+02:00
Add new methods from the new Firebase releases and update README
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ This repository started as a personal usage of [Nick Moskalenko](https://github.
 
 ```groovy
 dependencies {
-  compile 'com.github.frangsierra:rx2firebase:1.4.0'
+  compile 'com.github.frangsierra:rx2firebase:1.5.0'
 }
 ```
 ```
@@ -22,47 +22,13 @@ allprojects {
 	}
 ```
 
-
-## RxJava and RxJava 2.0
-One of the differences between RxJava and RxJava 2 is that RxJava 2 no longer accepts `null` values. Throwing a `NullPointerException` immediately. For this reason some of the methods of the library as been redesigned to return a `Completable` instead of a `Observable<Void>`. For example:
-
-#### RxFirebase 
-
-```java
-@NonNull
-public static Observable<Void> updateEmail(@NonNull final FirebaseUser firebaseUser, @NonNull final String email) {
-        return Observable.create(new Observable.OnSubscribe<Void>() {
-            @Override
-            public void call(final Subscriber<? super Void> subscriber) {
-                RxHandler.assignOnTask(subscriber, firebaseUser.updateEmail(email));
-            }
-        });
-}
-```
-
-#### Rx2Firebase
-
-```java
-@NonNull
-public static Completable updateEmail(@NonNull final FirebaseUser firebaseUser, @NonNull final String email) {
-        return Completable.create(new CompletableOnSubscribe() {
-            @Override
-            public void subscribe(CompletableEmitter emitter) throws Exception {
-                RxCompletableHandler.assignOnTask(emitter, firebaseUser.updateEmail(email));
-            }
-        });
-}
-```
-
-`RxCompletableHandler` manages the CompletableEmitters in the same way that `RxHandler` manages the `Subscriber`.
-You can check all the differences between RxJava and RxJava 2.0 in the next [Link](https://github.com/ReactiveX/RxJava/wiki/What's-different-in-2.0)
-
 ## Usage
 Library provides set of static methods of classes:
 * RxFirebaseAuth
 * RxFirebaseUser
 * RxFirebaseDatabase
 * RxFirebaseStorage
+* RxFirestore
 
 It also provides a custom implementation of `FirebaseRecyclerAdapter`:
 * RxFirebaseRecyclerAdapter
@@ -78,6 +44,35 @@ Sign in with email and password:
                     Log.i("Rxfirebase2", "User logged " + logged);
                 });
 ```
+### Firestore:
+
+You can observe values providing the Class of expected data like:
+
+```java
+    DocumentReference document = firestore.collection("Users").document("UserId_1");
+    RxFirestore.observeDocumentRef(document)
+       .subscribe( userDoc -> {
+          //Do something with my snapshot
+       });
+```
+
+Get and set documents on a specific reference:
+
+```java
+    DocumentReference document = firestore.collection("Users").document("UserId_1");
+    User mynewUser = User("newUserName", 24);
+    //Set data
+    RxFirestore.setDocument(document, myNewUser).subscribe();
+    //Get and map data
+    RxFirestore.getDocument(document)
+       .map( userDoc -> { return userDoc.toObject(User.class); })
+       .subscribe( casterUser -> {
+          //Do something with my already casted user
+       });
+```
+
+Finally you can do sync operations on the database using `runTransaction` and if you wanna realize multiple
+operations at once, you should use the method `atomicOperation` which wraps the `WriteBatch` related methods from Firestore.
 
 ### Database:
 
@@ -250,6 +245,40 @@ public class PostAdapter extends RxFirebaseRecyclerAdapter<PostViewHolder, Post>
 }
 ```
 
+## RxJava and RxJava 2.0
+One of the differences between RxJava and RxJava 2 is that RxJava 2 no longer accepts `null` values. Throwing a `NullPointerException` immediately. For this reason some of the methods of the library as been redesigned to return a `Completable` instead of a `Observable<Void>`. For example:
+
+#### RxFirebase
+
+```java
+@NonNull
+public static Observable<Void> updateEmail(@NonNull final FirebaseUser firebaseUser, @NonNull final String email) {
+        return Observable.create(new Observable.OnSubscribe<Void>() {
+            @Override
+            public void call(final Subscriber<? super Void> subscriber) {
+                RxHandler.assignOnTask(subscriber, firebaseUser.updateEmail(email));
+            }
+        });
+}
+```
+
+#### Rx2Firebase
+
+```java
+@NonNull
+public static Completable updateEmail(@NonNull final FirebaseUser firebaseUser, @NonNull final String email) {
+        return Completable.create(new CompletableOnSubscribe() {
+            @Override
+            public void subscribe(CompletableEmitter emitter) throws Exception {
+                RxCompletableHandler.assignOnTask(emitter, firebaseUser.updateEmail(email));
+            }
+        });
+}
+```
+
+`RxCompletableHandler` manages the CompletableEmitters in the same way that `RxHandler` manages the `Subscriber`.
+You can check all the differences between RxJava and RxJava 2.0 in the next [Link](https://github.com/ReactiveX/RxJava/wiki/What's-different-in-2.0)
+
 ## License
 
 	MIT License
diff --git a/app/build.gradle b/app/build.gradle
@@ -1,7 +1,7 @@
 buildscript {
     ext {
         rx_version = "2.1.10"
-        rx_android_version = "2.0.1"
+        rx_android_version = "2.0.2"
         firebase_auth_version='15.1.0'
         firebase_database_version='15.0.0'
         firebase_storage_version='15.0.2'
@@ -20,7 +20,7 @@ android {
     }
 
     compileSdkVersion 27
-    buildToolsVersion "26.0.2"
+    buildToolsVersion "26.0.3"
 
     defaultConfig {
         minSdkVersion 14
diff --git a/app/src/main/java/durdinapps/rxfirebase2/RxFirebaseAuth.java b/app/src/main/java/durdinapps/rxfirebase2/RxFirebaseAuth.java
@@ -6,7 +6,8 @@
 import com.google.firebase.auth.AuthCredential;
 import com.google.firebase.auth.AuthResult;
 import com.google.firebase.auth.FirebaseAuth;
-import com.google.firebase.auth.ProviderQueryResult;
+import com.google.firebase.auth.FirebaseUser;
+import com.google.firebase.auth.SignInMethodQueryResult;
 
 import io.reactivex.Completable;
 import io.reactivex.CompletableEmitter;
@@ -143,16 +144,16 @@ public void subscribe(MaybeEmitter<AuthResult> emitter) throws Exception {
      *
      * @param firebaseAuth firebaseAuth instance.
      * @param email        An email address.
-     * @return a {@link Maybe} which emits an {@link ProviderQueryResult} if success.
+     * @return a {@link Maybe} which emits an {@link SignInMethodQueryResult} if success.
      * @see <a href="https://firebase.google.com/docs/reference/android/com/google/firebase/auth/FirebaseAuth">Firebase Auth API</a>
      */
     @NonNull
-    public static Maybe<ProviderQueryResult> fetchProvidersForEmail(@NonNull final FirebaseAuth firebaseAuth,
-                                                                    @NonNull final String email) {
-        return Maybe.create(new MaybeOnSubscribe<ProviderQueryResult>() {
+    public static Maybe<SignInMethodQueryResult> fetchSignInMethodsForEmail(@NonNull final FirebaseAuth firebaseAuth,
+                                                                            @NonNull final String email) {
+        return Maybe.create(new MaybeOnSubscribe<SignInMethodQueryResult>() {
             @Override
-            public void subscribe(MaybeEmitter<ProviderQueryResult> emitter) throws Exception {
-                RxHandler.assignOnTask(emitter, firebaseAuth.fetchProvidersForEmail(email));
+            public void subscribe(MaybeEmitter<SignInMethodQueryResult> emitter) {
+                RxHandler.assignOnTask(emitter, firebaseAuth.fetchSignInMethodsForEmail(email));
             }
         });
     }
@@ -179,6 +180,26 @@ public void subscribe(CompletableEmitter emitter) throws Exception {
         });
     }
 
+    /**
+     * Asynchronously sets the provided user as currentUser on the current Auth instance. A new instance copy of the user provided will be made and set as currentUser.
+     * <p>
+     * This will trigger firebase.auth.Auth#onAuthStateChanged and firebase.auth.Auth#onIdTokenChanged listeners like other sign in methods.
+     * @param firebaseAuth firebaseAuth instance.
+     * @param newUser The new user to update the current instance.
+     * @return a {@link Completable} which emits when the action is completed.
+     * @see <a href="https://firebase.google.com/docs/reference/android/com/google/firebase/auth/FirebaseAuth">Firebase Auth API</a>
+     */
+    @NonNull
+    public static Completable updateCurrentUser(@NonNull final FirebaseAuth firebaseAuth,
+                                                     @NonNull final FirebaseUser newUser) {
+        return Completable.create(new CompletableOnSubscribe() {
+            @Override
+            public void subscribe(CompletableEmitter emitter) throws Exception {
+                RxCompletableHandler.assignOnTask(emitter, firebaseAuth.updateCurrentUser(newUser));
+            }
+        });
+    }
+
     /**
      * Observable which track the auth changes of {@link FirebaseAuth} to listen when an user is logged or not.
      *
diff --git a/app/src/main/java/durdinapps/rxfirebase2/RxFirestore.java b/app/src/main/java/durdinapps/rxfirebase2/RxFirestore.java
@@ -17,13 +17,13 @@
 import com.google.firebase.firestore.FirebaseFirestoreException;
 import com.google.firebase.firestore.ListenerRegistration;
 import com.google.firebase.firestore.MetadataChanges;
-
 import com.google.firebase.firestore.Query;
 import com.google.firebase.firestore.QuerySnapshot;
 import com.google.firebase.firestore.SetOptions;
 import com.google.firebase.firestore.Transaction;
 import com.google.firebase.firestore.WriteBatch;
 
+import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.Executor;
@@ -43,6 +43,7 @@
 import io.reactivex.SingleOnSubscribe;
 import io.reactivex.functions.Cancellable;
 import io.reactivex.functions.Function;
+import io.reactivex.schedulers.Schedulers;
 
 import static durdinapps.rxfirebase2.DocumentSnapshotMapper.DOCUMENT_EXISTENCE_PREDICATE;
 import static durdinapps.rxfirebase2.DocumentSnapshotMapper.QUERY_EXISTENCE_PREDICATE;
@@ -82,6 +83,37 @@ public void subscribe(CompletableEmitter emitter) throws Exception {
         });
     }
 
+   /**
+    * Execute all of the writes in this write batch as a single atomic unit.
+    *
+    * @param batches A list of write batched, used to perform multiple writes as a single atomic unit.
+    */
+   public static Completable atomicOperation(@NonNull final List<WriteBatch> batches) {
+      if (batches.isEmpty()) throw new IllegalArgumentException("Batches list can't be empty");
+
+      List<Completable> batchTasks = new ArrayList<>();
+      for (final WriteBatch batch : batches) {
+         batchTasks.add(Completable.create(new CompletableOnSubscribe() {
+            @Override public void subscribe(final CompletableEmitter emitter) {
+               batch.commit()
+                  .addOnSuccessListener(new OnSuccessListener<Void>() {
+                     @Override public void onSuccess(Void aVoid) {
+                        emitter.onComplete();
+                     }
+                  })
+                  .addOnFailureListener(new OnFailureListener() {
+                     @Override public void onFailure(@NonNull Exception e) {
+                        if (!emitter.isDisposed())
+                           emitter.onError(e);
+                     }
+                  });
+            }
+         }).subscribeOn(Schedulers.io()));
+      }
+
+      return Completable.merge(batchTasks);
+   }
+
     /**
      * Adds a new document to this collection with the specified data, assigning it a document ID automatically.
      *
diff --git a/app/src/test/java/durdinapps/rxfirebase2/RxFirebaseAuthTest.java b/app/src/test/java/durdinapps/rxfirebase2/RxFirebaseAuthTest.java
@@ -7,7 +7,7 @@
 import com.google.firebase.auth.AuthResult;
 import com.google.firebase.auth.FirebaseAuth;
 import com.google.firebase.auth.FirebaseUser;
-import com.google.firebase.auth.ProviderQueryResult;
+import com.google.firebase.auth.SignInMethodQueryResult;
 import com.google.firebase.database.DataSnapshot;
 
 import org.junit.Before;
@@ -43,7 +43,7 @@ public class RxFirebaseAuthTest {
     private Task<AuthResult> authResultTask;
 
     @Mock
-    private Task<ProviderQueryResult> providerQueryResultTask;
+    private Task<SignInMethodQueryResult> providerQueryResultTask;
 
     @Mock
     private Task<ActionCodeResult> actionCodeResultTask;
@@ -58,7 +58,7 @@ public class RxFirebaseAuthTest {
     private AuthResult authResult;
 
     @Mock
-    private ProviderQueryResult providerQueryResult;
+    private SignInMethodQueryResult providerQueryResult;
 
     @Mock
     private ActionCodeResult actionCodeResult;
@@ -88,7 +88,7 @@ public void setup() {
         when(firebaseAuth.signInWithCredential(authCredential)).thenReturn(authResultTask);
         when(firebaseAuth.signInWithCustomToken(ANY_TOKEN)).thenReturn(authResultTask);
         when(firebaseAuth.createUserWithEmailAndPassword(ANY_EMAIL, ANY_PASSWORD)).thenReturn(authResultTask);
-        when(firebaseAuth.fetchProvidersForEmail(ANY_EMAIL)).thenReturn(providerQueryResultTask);
+        when(firebaseAuth.fetchSignInMethodsForEmail(ANY_EMAIL)).thenReturn(providerQueryResultTask);
         when(firebaseAuth.checkActionCode(ANY_CODE)).thenReturn(actionCodeResultTask);
         when(firebaseAuth.verifyPasswordResetCode(ANY_CODE)).thenReturn(checkCodeResultTask);
         when(firebaseAuth.sendPasswordResetEmail(ANY_EMAIL)).thenReturn(voidTask);
@@ -275,14 +275,14 @@ public void signInWithCustomTokenError() throws InterruptedException {
     @Test
     public void fetchProvidersForEmail() throws InterruptedException {
 
-        TestObserver<ProviderQueryResult> authTestObserver = RxFirebaseAuth
-            .fetchProvidersForEmail(firebaseAuth, ANY_EMAIL)
+        TestObserver<SignInMethodQueryResult> authTestObserver = RxFirebaseAuth
+            .fetchSignInMethodsForEmail(firebaseAuth, ANY_EMAIL)
             .test();
 
         testOnSuccessListener.getValue().onSuccess(providerQueryResult);
         testOnCompleteListener.getValue().onComplete(providerQueryResultTask);
 
-        verify(firebaseAuth).fetchProvidersForEmail(eq(ANY_EMAIL));
+        verify(firebaseAuth).fetchSignInMethodsForEmail(eq(ANY_EMAIL));
 
         authTestObserver.assertNoErrors()
             .assertValueCount(1)
@@ -313,13 +313,13 @@ public void checkActionCode() throws InterruptedException {
     @Test
     public void fetchProvidersForEmailError() throws InterruptedException {
 
-        TestObserver<ProviderQueryResult> authTestObserver = RxFirebaseAuth
-            .fetchProvidersForEmail(firebaseAuth, ANY_EMAIL)
+        TestObserver<SignInMethodQueryResult> authTestObserver = RxFirebaseAuth
+            .fetchSignInMethodsForEmail(firebaseAuth, ANY_EMAIL)
             .test();
 
         testOnFailureListener.getValue().onFailure(EXCEPTION);
 
-        verify(firebaseAuth).fetchProvidersForEmail(ANY_EMAIL);
+        verify(firebaseAuth).fetchSignInMethodsForEmail(ANY_EMAIL);
 
         authTestObserver.assertError(EXCEPTION)
             .assertNotComplete()
