sd10/nora

Nora is a Firebase abstraction layer for FirebaseDatabase and FirebaseStorage

---

Nora is a Firebase abstraction layer for working with FirebaseDatabase and FirebaseStorage.

Stop spending all that time cleaning up your view controllers and trying to write reusable Firebase code.

Let Nora handle that for you. Your time is better spent on what you do best. Writing great Apps!

Simply put, working with Firebase just got whole lot easier.

---

Installation

CocoaPods Recommended

  pod 'Nora'

Example

Working with FirebaseDatabase

After setting up a target making requests is simple.

let database = DatabaseProvider<Users>()

database.request(.getUser(id: "1")) { result in
  switch result {
  case .success(let response):
    let snapshot = response.snapshot
  case .failure(let error):
    print(error.localizedDescription)
  }
}

Database Response Decoding

Provide a JSON initializer for your custom types and easily convert the database response:

let database = DatabaseProvider<Users>()

database.request(.getUser(id: "1")) { result in
  switch result {
  case .success(let response):
    let user = try? response.mapTo(User.init)
  case .failure(let error):
    print(error.localizedDescription)
  }
}

---

Working with FirebaseStorage

let storage = StorageProvider<Avatars>()
let avatarData = Data()
var meta = FIRStorageMetadata?

storage.request(.upload(avatarData, meta)) { result in
  switch result {
  case .success(_):
    print("Upload Success!")
  case .failure(let error):
    print(error.localizedDescription)
  }
}

---

Documentation (In Progress)

DatabaseTarget Documentation

DatabaseProvider Documentation

---

Get involved

You can contribute to this project in more ways than just code:

• Improving the README
• Improving Documentation
• Bug reporting
• New feature suggestions
• Answering questions

We really encourage everyone to get involved in open source.

Your feedback is always welcome and much appreciated!

REGARDLESS, of your level of experience.

You will never be put down for having an opinion. So take a chance, open a pull request, or submit that issue!

---

Inspiration

This project was inspired and based off the Moya networking abstraction layer in Swift.

Check out their project if you're using traditional networking!

---

License

Nora is released under an MIT license. See LICENSE.md for more information.

nora's Issues

Improve FIRDatabaseQuery support by upgrading the Request builder

Reasoning

Switching to a String path based API cost us a lot of support for FIRDatabaseQuery's
This is the top priority

Add flatMapChildrenTo and flatMapTo methods under DatabaseResponse extensions

Reasoning:

Since mapTo and mapChildrenTo are throwing methods it can be inconvenient to have to either force unwrap or use a do-catch block to obtain a non-optional value.

Update DatabaseQuery API

Update DatabaseQuery API

The queries property of DatabaseTarget is currently an array of DatabaseQuery.
I really never liked this interface and think it would be more user-friendly if it were a linked list.

Add check for empty string path when building the DatabaseRequest

Reasoning:

Currently, you can't use an empty String for the path property of DatabaseTarget in order to default to using the baseReference. This can be easily be fixed by adding a check for an empty string and only calling child(path:) on the baseReference if the String is not empty.

What is the pro and cons Nora vs pyrobase?

first, thanks for writing the library and second

What is the pro and cons Nora vs pyrobase? trying to understand which one is better fit for one scenario and not the others.

https://github.com/mownier/pyrobase

Update for latest version of Firebase

Needs an update to new version of Firebase

• Resolve naming convention conflicts by adding NR prefix
• Update to new Firebase API
• Update Podfile to new FirebaseDatabase & FirebaseStorage versions

Set up TravisCI

TravisCI is not currently set up but the build is working fine

Firestore Supported

Hi,

Can this also be used with Firestore?

Why does a `Result.failure` has an optional `Error`?

Why is this Error optional? When would there be a failure, but no error?

Make as framework?

Hey guys!
It's interesting project, but without supporting installation via Cocoapods or Carthage.
How about let's do this?

Make completion block for providers optional

Reasoning

Users of the API may not want to provide a completion block when updating or removing data.
This should be an easy change by changing the routing of a request if the completion block is not provided. Will update shortly

Explore using Swift Codable instead of JSONDecodeable

Use Jazzy to auto-generate documentation

We just installed Jazzy over @SwifterSwift and it's been an awesome experience. I'd like to do the same for this repository. It will be much easier to maintain that markdown docs.