Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/firebase4s/firebase4s
A Firebase SDK for Scala
https://github.com/firebase4s/firebase4s
database firebase firebase-sdk realtime-database scala
Last synced: 14 days ago
JSON representation
A Firebase SDK for Scala
- Host: GitHub
- URL: https://github.com/firebase4s/firebase4s
- Owner: firebase4s
- License: mit
- Created: 2017-11-30T21:35:36.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-01-02T19:11:32.000Z (almost 3 years ago)
- Last Synced: 2024-10-22T11:12:01.002Z (15 days ago)
- Topics: database, firebase, firebase-sdk, realtime-database, scala
- Language: Scala
- Homepage:
- Size: 239 KB
- Stars: 23
- Watchers: 1
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/firebase4s/firebase4s)
[](https://index.scala-lang.org/firebase4s/firebase4s/firebase4s)
[](https://gitter.im/firebase4s/firebase4s)
[](https://opensource.org/licenses/MIT)
### Overview
Firebase4s aims to provide a Scala-friendly alternative to the [Firebase Java SDK](https://github.com/firebase/firebase-admin-java). By providing more idiomatic API interfaces and automatically handling Scala-to-Java data conversions, Firebase4s eliminates much of the [boilerplate](https://medium.com/@RICEaaron/scala-firebase-da433df93bd2) required to use the Java SDK. Firebase4s currently provides the same [Realtime Database](#database) and [Authentication](#authentication) features as the Java SDK and aims to provide all of the same [functionality](https://firebase.google.com/docs/admin/setup) over time.
----------
### Getting Started
To use `firebase4s` in your project, add the following to your `build.sbt`:
```scala
libraryDependencies += "com.github.firebase4s" %% "firebase4s" % "0.0.4"
```
Initialize the `App` with your Firebase service account credentials and database url, which may be obtained from the [Firebase console](https://console.firebase.google.com).
```scala
import com.firebase4s.App
val serviceAccount = getClass.getResourceAsStream("/serviceAccountCredentials.json")
App.initialize(serviceAccount, "https://.firebaseio.com")
```
*The above code snippet assumes that your Firebase service account credentials exist in your project's `resources` directory.*
To get an instance of a `DatabaseReference`:
```scala
import com.firebase4s.database.Database
val db: Database = Database.getInstance()
val fooRef: DatabaseReference = db.ref("foo")
```
There are five *categories* of supported data types:
##### *Simple Types*: `String`, `Boolean`, `Int`, `Long`, `Double`
##### *Maps containing Simple Types*: `Map[String, String]`, `Map[String, Boolean]`, etc.
##### *Iterables containing Simple Types*: `List[String]` , `Vector[Long]`, etc.
##### *Options of any of the above*: `Option[Int]`, `Option[List[String]]`, etc.
##### *Classes*
*Currently, only [`JavaBean`](https://en.wikipedia.org/wiki/JavaBeans) classes are supported. However, Firebase4s offers a [`toMap`](#toMap) helper method which makes working with non-nested case classes easier. Future versions of Firebase4s will fully support the use of `case classes` through the use of [Scala Macro Annotations](https://docs.scala-lang.org/overviews/macros/annotations.html). and/or [Shapeless](https://github.com/milessabin/shapeless)*
#### Examples:
Set and retrieve a `List[Int]`:
```scala
/** Get a database reference */
val listRef: DatabaseReference = db.ref("myList")
/** Set value at reference location */
val result: Future[List[Int]] = liftRef.set(List(1, 2, 3))
/** Get value at ref location */
ref.get()
.map(snapshot => snapshot.getValue)
.map((list: Option[List[Int]]) => ???) // handle result
```
Set and retrieve a `User`:
```scala
import scala.beans.BeanProperty
/** JavaBean Class Constructor */
class User() {
@BeanProperty var name: String = _
@BeanProperty var email: String = _
}
/** Get a database reference */
val userRef = db.ref("user")
/** Create user */
val user = new User()
user.name = "timothy"
user.email = "[email protected]"
/** Set user at ref location */
userRef.set(user).foreach(println) // User("timothy","[email protected]")
/** Get user at ref location */
userRef.get()
.map(snapshot => snapshot.getValue(classOf[User]))
.map((user: Option[UserRecord]) => ???) // handle result
```
Working with `case classes`:
```scala
/**
* The Helpers module provides a `toMap` method which
* we can invoke on our case class to convert it to a
* Map[String, Any] that can be set as a value in the
* in the database. When retrieving the value as this
* ref location, we will get back a Map[String, Any]
* representation of our case class instance.
*/
import com.firebase4s.database.Helpers._
case class User(name: String, age: Int)
val user = User("tim", 44)
val userRef = db.ref("user")
userRef.set(user.toMap)
userRef.get().foreach(snapshot => {
println(snapshot.getValue) // Map(name -> tim, age -> 44)
})
```
##### Create a User:
```scala
import com.firebase4s.{Auth, UserCreationProps}
val auth: Auth = Auth.getInstance()
// User Props
val props = UserCreationProps(
email = Some("[email protected]"),
displayName = Some("tim"),
phoneNumber = Some("+1555555555"),
photoUrl = Some("http://testing.com/photo.jpeg")
)
auth.createUser(props)
.map((user: UserRecord) => ???) // handle results
```
##### Update a User:
```scala
import com.firebase4s.{Auth, UserUpdateProps}
val auth: Auth = Auth.getInstance()
// Props to update
val props = UserUpdateProps(
email = Some("[email protected]"),
phoneNumber = Some("+15655655555")
)
auth.updateUser(props)
.map((user: UserRecord) => ???) // handle results
```
##### Delete a User:
```scala
auth.deleteUser(user.uid)
.map(uid => ???) // handle result
```
##### Verify a Firebase ID Token:
```scala
auth.verifyIdToken(token)
.map((token: FirebaseToken) => token.uid)
.map(userId => ???)
```
##### Create a Custom Token:
```scala
val extraClaims = Map("admin" -> true)
auth.createCustomToken(uid, Some(extraClaims)))
.map(token => ???]) // Provide token to client
```