Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/csfrequency/firebase-device-store-ios-sdk

Automatically store Device and FCM Token information for Firebase Auth Users in Cloud Firestore
https://github.com/csfrequency/firebase-device-store-ios-sdk

firebase firebase-auth firebase-authentication firebase-cloud-firestore firebase-cloud-messaging firebase-firestore firebase-messaging ios-sdk swift

Last synced: 8 days ago
JSON representation

Automatically store Device and FCM Token information for Firebase Auth Users in Cloud Firestore

Awesome Lists containing this project

README 

        
# Firebase Device Store (iOS SDK)



Automatically store Device and FCM Token information for Firebase Auth Users in Cloud Firestore.



> This library is a proof of concept, and very much a work in progress.



## Installation



Add `FirebaseDeviceStore` to your `Podfile`:



```

pod 'FirebaseDeviceStore'

```



### Objective-C



Make sure you have `use_frameworks!` enabled in your `Podfile`



## Example usage



### Swift



Import the library:



```

import FirebaseDeviceStore

```



Initialise the library:



```

let deviceStore = FirebaseDeviceStore.init(app: FirebaseApp.app()!);

// Subscribe to the device store and ensure that appropriate notification permissions are granted

deviceStore.subscribe { (error) in

  // Handle permission errors here

}

```



### Objective-C



Import the library:



```

#import "FirebaseDeviceStore-Swift.h"

```



Initialise the library:



```

FirebaseDeviceStore *deviceStore = [[FirebaseDeviceStore alloc] initWithApp:[FIRApp defaultApp]];

// Subscribe to the device store and ensure that appropriate notification permissions are granted

[deviceStore subscribe:^(NSError * _Nullable error) {

  // Handle permission errors here

}];

```



## Documentation



Firebase Device Store automatically stores device and FCM information for Firebase Auth users in Cloud Firestore.



### Data Model



A Document is created in the Cloud Firestore collection for each logged in user:



```

/user-devices

  - userId1: {},

  - userId2: {},

```



The structure of this Document is as follows:



```

{

  devices: {

    deviceId1: Device,

    deviceId2: Device,

    ...

  },

  userId: string,

}

```



A `Device` object contains the following:



```

{

  deviceId: string, // A UUID for the device

  fcmToken: string, // The FCM token

  name: string,     // The name of the device (e.g. 'Bob's iPhone')

  os: string,       // The OS of the device

  type: 'iOS'

}

```



### API (Swift)



#### `FirebaseDeviceStore.init(app: FIRApp, collectionPath: String?)`



Create a new DeviceStore.



Parameters:



- `app`: `FirebaseApp` (Optional) the Firebase App to use. Defaults to the default Firebase App.

- `collectionPath`: (Optional) `string` the Cloud Firestore collection where devices should be stored. Defaults to `user-devices`.



Returns a `FirebaseDeviceStore`.



#### `signOut(completion: (Error?) -> Void): void`



Indicate to the DeviceStore that the user is about to sign out, and the current device token should be removed.



This can't be done automatically with `onAuthStateChanged` as the user is already signed out at this point. This means the Cloud Firestore security rules will prevent the database deletion as they no longer have the correct user permissions to remove the token.



Parameters:



- `completion`: `(Error?) -> Void` a callback handler which will be called with an `Error` if signing out wasn't successful, or `nil` otherwise



#### `subscribe(completion: (Error?) -> Void): void`



Subscribe a device store to the Firebase App. This will:



1. Request appropriate Notification permissions, if they have not already been granted

2. Subscribe to Firebase Auth and listen to changes in authentication state

3. Subscribe to Firebase Cloud Messaging and listen to changes in the FCM token

4. Automatically store device and FCM token information in the Cloud Firestore collection you specify



Parameters:



- `completion`: `(Error?) -> Void` a callback handler which will be called with an `Error` if the susbcription wasn't successful, or `nil` otherwise



#### `unsubscribe(): void`



Unsubscribe the device store from the Firebase App.



### API (Objective-C)



#### `[FirebaseDeviceStore initWithApp: FIRApp collectionPath: NSString]`



Create a new DeviceStore.



Parameters:



- `app`: `FirebaseApp` (Optional) the Firebase App to use. Defaults to the default Firebase App.

- `collectionPath`: (Optional) `string` the Cloud Firestore collection where devices should be stored. Defaults to `user-devices`.



Returns a `FirebaseDeviceStore`.



#### `signOut:(void (^ _Nonnull)(NSError * _Nullable))completion: void`



Indicate to the DeviceStore that the user is about to sign out, and the current device token should be removed.



This can't be done automatically with `onAuthStateChanged` as the user is already signed out at this point. This means the Cloud Firestore security rules will prevent the database deletion as they no longer have the correct user permissions to remove the token.



Parameters:



- `completion`: `(void (^ _Nonnull)(NSError * _Nullable))` a callback handler which will return an `Error` if signing out wasn't successful, or `nil` otherwise



#### `subscribe:(void (^ _Nonnull)(NSError * _Nullable))completion: void`



Subscribe a device store to the Firebase App. This will:



1. Request appropriate Notification permissions, if they have not already been granted

2. Subscribe to Firebase Auth and listen to changes in authentication state

3. Subscribe to Firebase Cloud Messaging and listen to changes in the FCM token

4. Automatically store device and FCM token information in the Cloud Firestore collection you specify



Parameters:



- `completion`: `(void (^ _Nonnull)(NSError * _Nullable))` a callback handler which will return an `Error` if the susbcription wasn't successful, or `nil` otherwise



#### `unsubscribe: void`



Unsubscribe the device store from the Firebase App.



### Security rules



You will need to add the following security rules for your Cloud Firestore collection:



```

service cloud.firestore {

  match /databases/{database}/documents {

    // Add this rule, replacing `user-devices` with the collection path you would like to use:

    match /user-devices/{userId} {

      allow create, read, update, delete: if request.auth.uid == userId;

    }

  }

}

```