init

Author: ctf0

.gitignore

@@ -0,0 +1 @@
+.DS_Store

README.md

@@ -1,2 +1,57 @@
-# laravel-firebase-broadcast-driver
-a firebase broadcast driver for laravel
+<h1 align="center">
+    FireBase Broadcast Driver
+    <br>
+    <a href="https://packagist.org/packages/ctf0/firebase-broadcast-driver"><img src="https://img.shields.io/packagist/v/ctf0/firebase-broadcast-driver.svg" alt="Latest Stable Version" /></a> <a href="https://packagist.org/packages/ctf0/firebase-broadcast-driver"><img src="https://img.shields.io/packagist/dt/ctf0/firebase-broadcast-driver.svg" alt="Total Downloads" /></a>
+</h1>
+
+## Installation
+
+- `composer require ctf0/firebase-broadcast-driver`
+
+- the package internally use [`kreait/firebase-php`](https://firebase-php.readthedocs.io/en/latest/) to send data to firebase.
+
+### Config
+```php
+// config/broadcasting
+
+return [
+    'connections'=> [
+        // ...
+
+        'firebase'=> [
+            'driver'=> 'firebase',
+            'apiKey'=> env('FB_API_KEY'),
+            'databaseURL'=> env('FB_DB_URL'), // the real time database url'projectId'=> env('FB_PROJECT_ID'),
+            'creds_file'=> env('FB_CREDENTIALS_FILE'),
+            'collection_name'=> env('FB_COLLECTION_NAME'), // ex.notifications
+        ],
+    ],
+];
+```
+
+### Usage
+
+- 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.
+
+    but 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"
+    },
+  }
+}
+```

composer.json

@@ -0,0 +1,45 @@
+{
+    "name": "ctf0/firebase-broadcast-driver",
+    "description": "a firebase broadcast driver for laravel",
+    "homepage": "https://github.com/ctf0/laravel-firebase-broadcast-driver",
+    "license": "MIT",
+    "keywords": [
+        "ctf0",
+        "laravel",
+        "firebase",
+        "broadcast"
+    ],
+    "authors": [
+        {
+            "name": "Muah",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "php": "~7.0",
+        "illuminate/support": "5.5 - 5.8",
+        "kreait/firebase-php": "*",
+        "ctf0/package-changelog": "*"
+    },
+    "autoload": {
+        "psr-4": {
+            "ctf0\\Firebase\\": "src"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "ctf0\\Firebase\\FireBaseBroadcastProvider"
+            ]
+        },
+        "changeLog": "logs"
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "scripts": {
+        "post-package-install": [
+            "@php artisan vendor:publish --provider=\"ctf0\\Firebase\\FireBaseBroadcastProvider\""
+        ]
+    }
+}

src/FireBaseBroadcastProvider.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace ctf0\Firebase;
+
+use Illuminate\Support\ServiceProvider;
+use Illuminate\Broadcasting\BroadcastManager;
+
+class FireBaseBroadcastProvider extends ServiceProvider
+{
+    /**
+     * Perform post-registration booting of services.
+     */
+    public function boot()
+    {
+        app(BroadcastManager::class)->extend('firebase', function ($app) {
+            return new FireBaseBroadcaster();
+        });
+    }
+
+    public function register()
+    {
+    }
+}

src/FireBaseBroadcaster.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace ctf0\Firebase;
+
+use Illuminate\Support\Arr;
+use Kreait\Firebase\Factory;
+use Kreait\Firebase\ServiceAccount;
+use Kreait\Firebase\Exception\ApiException;
+use Illuminate\Broadcasting\BroadcastException;
+use Illuminate\Broadcasting\Broadcasters\Broadcaster;
+
+class FireBaseBroadcaster extends Broadcaster
+{
+    protected $db;
+    protected $config;
+
+    /**
+     * Create a new broadcaster instance.
+     */
+    public function __construct()
+    {
+        $this->config = config('broadcasting.connections.firebase');
+
+        $sr_account = ServiceAccount::fromJsonFile(base_path(Arr::get($this->config, 'creds_file')));
+
+        $this->db = (new Factory())
+                        ->withServiceAccount($sr_account)
+                        ->withDatabaseUri(Arr::get($this->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(Arr::get($this->config, 'collection_name'))->push([
+                'channels' => $this->formatChannels($channels),
+                'data'     => $payload,
+                'event'    => $event,
+            ]);
+        } catch (ApiException $e) {
+            throw new BroadcastException($e);
+        }
+    }
+}