add support for firestore

Author: ctf0

README.md

@@ -15,14 +15,15 @@
 // config/broadcasting
 
 return [
-    'connections'=> [
+    'connections' => [
         // ...
 
-        'firebase'=> [
-            'driver'=> 'firebase',
-            'databaseURL'=> env('FB_DB_URL'), // the real time database url
-            'creds_file'=> env('FB_CREDENTIALS_FILE'), // service account json file
-            'collection_name'=> env('FB_COLLECTION_NAME'), // ex.notifications
+        'firebase' => [
+            'driver' => 'firebase',
+            'type' => 'rtdb', // rtdb or fsdb
+            'databaseURL' => env('FB_DB_URL'), // the real time database url
+            'creds_file' => env('FB_CREDENTIALS_FILE'), // service account json file
+            'collection_name' => env('FB_COLLECTION_NAME'), // ex.notifications
         ],
     ],
 ];
@@ -33,24 +34,24 @@ return [
 - add `BROADCAST_DRIVER=firebase` to `.env`
 
 - atm there no support for [laravel-echo](https://laravel.com/docs/5.8/broadcasting#installing-laravel-echo) "any help is appreciated" but no worries, you still get the same payload as other broadcast drivers.
-   
-   however you can check the [firebase api docs](https://firebase.google.com/docs/database/web/start) or [vuefire](https://github.com/vuejs/vuefire) if you are using `vue`, on how to listen for changes and update your app users accordingly.
 
+    however you can check the [firebase api docs](https://firebase.google.com/docs/database/web/start) or [vuefire](https://github.com/vuejs/vuefire) if you are using `vue`, on how to listen for changes and update your app users accordingly.
 
 #### Notification Data Sample
 ```json
 {
-  "notifications" : {
-    "-LkgtAVVw0Ztwyjayd9n" : {
-      "channels" : [ "private-App.User.091b0f7e-805b-4aab-8c99-445039157783" ],
-      "data" : {
-        "body" : "some body",
-        "id" : "d54c44a2-8a42-43a4-bae0-e2b159d1533b",
-        "title" : "some title",
-        "type" : "App\\Notifications\\AlertUser"
-      },
-      "event" : "Illuminate\\Notifications\\Events\\BroadcastNotificationCreated"
-    },
-  }
+    "notifications" : {
+        "-LkgtAVVw0Ztwyjayd9n" : {
+            "channels" : [ "private-App.User.091b0f7e-805b-4aab-8c99-445039157783" ],
+            "data" : {
+                "body" : "some body",
+                "id" : "d54c44a2-8a42-43a4-bae0-e2b159d1533b",
+                "title" : "some title",
+                "type" : "App\\Notifications\\AlertUser"
+            },
+            "event" : "Illuminate\\Notifications\\Events\\BroadcastNotificationCreated",
+            "timestamp": 1564183089538
+        }
+    }
 }
 ```

composer.json

@@ -20,6 +20,9 @@
         "illuminate/support": "5.5 - 5.8",
         "kreait/firebase-php": "*"
     },
+    "suggest": {
+        "morrislaptop/firestore-php": "Required to use with firestore db."
+    },
     "autoload": {
         "psr-4": {
             "ctf0\\Firebase\\": "src"
@@ -38,7 +41,7 @@
     },
     "scripts": {
         "post-package-install": [
-            "@php artisan vendor:publish --provider=\"ctf0\\Firebase\\FireBaseBroadcastProvider\""
+            "@php artisan vendor:publish --provider = \"ctf0\\Firebase\\FireBaseBroadcastProvider\""
         ]
     }
 }

src/FireBaseBroadcaster.php renamed to src/Broadcasters/FSDB.php

@@ -1,15 +1,15 @@
 <?php
 
-namespace ctf0\Firebase;
+namespace ctf0\Firebase\Broadcasters;
 
-use Illuminate\Support\Arr;
-use Kreait\Firebase\Factory;
+use Illuminate\Support\Str;
 use Kreait\Firebase\ServiceAccount;
+use Morrislaptop\Firestore\Factory;
 use Kreait\Firebase\Exception\ApiException;
 use Illuminate\Broadcasting\BroadcastException;
 use Illuminate\Broadcasting\Broadcasters\Broadcaster;
 
-class FireBaseBroadcaster extends Broadcaster
+class FSDB extends Broadcaster
 {
     protected $db;
     protected $config;
@@ -21,12 +21,11 @@ public function __construct()
     {
         $this->config = config('broadcasting.connections.firebase');
 
-        $sr_account = ServiceAccount::fromJsonFile(base_path(Arr::get($this->config, 'creds_file')));
+        $sr_account = ServiceAccount::fromJsonFile(base_path($this->config['creds_file']));
 
         $this->db = (new Factory())
                         ->withServiceAccount($sr_account)
-                        ->withDatabaseUri(Arr::get($this->config, 'databaseURL'))
-                        ->create();
+                        ->createFirestore();
     }
 
     /**
@@ -48,10 +47,12 @@ public function validAuthenticationResponse($request, $result)
      */
     public function broadcast(array $channels, $event, array $payload = [])
     {
-        $db = $this->db->getDatabase();
+        $db = $this->db;
 
         try {
-            $db->getReference(Arr::get($this->config, 'collection_name'))->push([
+            $coll = $db->collection($this->config['collection_name']);
+            $doc  = $coll->document(md5(Str::uuid()));
+            $doc->set([
                 'timestamp' => round(now()->valueOf()), // return date == to js Date.now()
                 'channels'  => $this->formatChannels($channels),
                 'data'      => $payload,

src/Broadcasters/RTDB.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace ctf0\Firebase\Broadcasters;
+
+use Kreait\Firebase\Factory;
+use Kreait\Firebase\ServiceAccount;
+use Kreait\Firebase\Exception\ApiException;
+use Illuminate\Broadcasting\BroadcastException;
+use Illuminate\Broadcasting\Broadcasters\Broadcaster;
+
+class RTDB extends Broadcaster
+{
+    protected $db;
+    protected $config;
+
+    /**
+     * Create a new broadcaster instance.
+     *
+     * @param mixed $config
+     */
+    public function __construct($config)
+    {
+        $sr_account   = ServiceAccount::fromJsonFile(base_path($config['creds_file']));
+        $this->config = $config;
+        $this->db     = (new Factory())
+                        ->withServiceAccount($sr_account)
+                        ->withDatabaseUri($config['databaseURL'])
+                        ->create();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function auth($request)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function validAuthenticationResponse($request, $result)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function broadcast(array $channels, $event, array $payload = [])
+    {
+        $db = $this->db->getDatabase();
+
+        try {
+            $db->getReference($this->config['collection_name'])
+                ->push([
+                    'timestamp' => round(now()->valueOf()), // return date == to js Date.now()
+                    'channels'  => $this->formatChannels($channels),
+                    'data'      => $payload,
+                    'event'     => $event,
+                ]);
+        } catch (ApiException $e) {
+            throw new BroadcastException($e);
+        }
+    }
+}

src/FireBaseBroadcastProvider.php

@@ -2,6 +2,8 @@
 
 namespace ctf0\Firebase;
 
+use ctf0\Firebase\Broadcasters\FSDB;
+use ctf0\Firebase\Broadcasters\RTDB;
 use Illuminate\Support\ServiceProvider;
 use Illuminate\Broadcasting\BroadcastManager;
 
@@ -13,7 +15,9 @@ class FireBaseBroadcastProvider extends ServiceProvider
     public function boot()
     {
         app(BroadcastManager::class)->extend('firebase', function ($app) {
-            return new FireBaseBroadcaster();
+            $config = config('broadcasting.connections.firebase');
+
+            return $config['type'] == 'rtdb' ? new RTDB($config) : new FSDB($config);
         });
     }