rxFirebase
nmoskalenko
315
Visit GitHub RepoNoSQL

Hex.pm Platform Download Build Status Build Status codecov

RxFirebase

RxJava wrapper on Google's Firebase for Android library.

Usage

Library provides set of static methods of classes:

  • RxFirebaseAuth
  • RxFirebaseUser
  • RxFirebaseDatabase
  • RxFirebaseStorage

Authentication:

Sign in anonymously and get token:

RxFirebaseAuth.signInAnonymously(FirebaseAuth.getInstance())
                .flatMap(x -> RxFirebaseUser.getToken(FirebaseAuth.getInstance().getCurrentUser(), false))
                .subscribe(token -> {
                    Log.i("RxFirebaseSample", "user token: " + token.getToken());
                }, throwable -> {
                    Log.e("RxFirebaseSample", throwable.toString());
                });

Database:

Many thanks to @renanferrari for making it much more flexible.

You can simply observe values providing the Class of expected data like:

RxFirebaseDatabase.observeSingleValue(reference.child("users").child("nick"), User.class)
            .subscribe(user -> {
                // process user value(nullable)
            });

or providing your own mapper between DataSnapshot and your data type:

RxFirebaseDatabase.observeSingleValueEvent(reference.child("posts"),
                dataSnapshot -> {
                    // do your own mapping here
                    return new User();
                })
                .subscribe(user -> {
                    // process user value
                });

There are some pre-defined mappers to make things easier:

Observing list values
RxFirebaseDatabase.observeSingleValueEvent(reference.child("posts"), DataSnapshotMapper.listOf(BlogPost.class))
                .subscribe(blogPost -> {
                    // process blogPost list item
                });
Observing map values
        RxFirebaseDatabase.observeSingleValueEvent(reference.child("posts"), DataSnapshotMapper.mapOf(BlogPost.class))
                .subscribe(blogPostAsMapItem -> {
                    // process blogPost as key-value pair
                });

Storage

Download file from Firebase storage

StorageReference storageRef = FirebaseStorage.getInstance().getReferenceFromUrl("gs://project-1125675579821020265.appspot.com");
RxFirebaseStorage.getFile(storageRef.child("README.md"), targetFile)
        .subscribe(snapshot -> {
            Log.i("RxFirebaseSample", "transferred: " + snapshot.getBytesTransferred() + " bytes");
        }, throwable -> {
            Log.e("RxFirebaseSample", throwable.toString());
        });

or download file as bytes array

RxFirebaseStorage.getBytes(storageRef.child("README.md"), 1024 * 100)
                .subscribe(bytes -> {
                    Log.i("RxFirebaseSample", "downloaded: " + new String(bytes));
                }, throwable -> {
                    Log.e("RxFirebaseSample", throwable.toString());
                });

Download

Gradle:
dependencies {
  compile 'com.google.firebase:firebase-auth:9.4.0'
  compile 'com.google.firebase:firebase-database:9.4.0'
  compile 'com.google.firebase:firebase-storage:9.4.0'
  compile 'com.kelvinapps:rxfirebase:0.0.15'
}
Maven:
<dependency>
  <groupId>com.kelvinapps</groupId>
  <artifactId>rxfirebase</artifactId>
  <version>0.0.15</version>
  <type>pom</type>
</dependency>

License

Copyright 2016 Nickolay Moskalenko

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Become a better Android Developer
Millions of developers are learning at MindOrks

Online Training Program

Featured Blogs

Our Team

MindOrks is Certainly one of the best online blog to stay on top of all the Android development news, coding and design patterns. Finally a blog I can count on to keep myself updated with latest and greatest things happening in Android world.

Vipul Shah
Android Developer
Microsoft

Become Pro in Android by watching videos

OUR LEARNERS WORK AT