Merge branch 'patrickkivits-feature-database-driver'

Author: Alymosul

README.md

@@ -28,7 +28,7 @@ You can install the package via composer:
 composer require alymosul/laravel-exponent-push-notifications
 ```
 
-You must install the service provider:
+If you are using Laravel 5.5 or higher this package will automatically register itself using [Package Discovery](https://laravel.com/docs/5.5/packages#package-discovery). For older versions of Laravel you must install the service provider manually:
 
 ```php
 // config/app.php
@@ -38,6 +38,39 @@ You must install the service provider:
 ],
 ```
 
+You can publish the migration with:
+```bash
+php artisan vendor:publish --provider="NotificationChannels\ExpoPushNotifications\ExpoPushNotificationsServiceProvider" --tag="migrations"
+```
+
+After publishing the migration you can create the `exponent_push_notification_interests` table by running the migrations:
+
+```bash
+php artisan migrate
+```
+
+You can optionally publish the config file with:
+```bash
+php artisan vendor:publish --provider="NotificationChannels\ExpoPushNotifications\ExpoPushNotificationsServiceProvider" --tag="config"
+```
+
+This is the contents of the published config file:
+
+```php
+return [
+    'interests' => [
+        /*
+         * Supported: "file", "database"
+         */
+        'driver' => env('EXPONENT_PUSH_NOTIFICATION_INTERESTS_STORAGE_DRIVER', 'file'),
+
+        'database' => [
+            'table_name' => 'exponent_push_notification_interests',
+        ],
+    ]
+];
+```
+
 ## Usage
 
 ``` php

composer.json

@@ -12,19 +12,21 @@
     ],
     "require": {
         "php": ">=7.0",
-        "alymosul/exponent-server-sdk-php": "1.0.*",
-        "illuminate/notifications": "5.3.* || 5.4.* || 5.5.* || 5.6.*",
-        "illuminate/support": "5.3.* || 5.4.* || 5.5.* || 5.6.*",
-        "illuminate/events": "5.3.* || 5.4.* || 5.5.* || 5.6.*",
-        "illuminate/queue": "5.3.* || 5.4.* || 5.5.* || 5.6.*",
-        "illuminate/http": "5.3.* || 5.4.* || 5.5.* || 5.6.*",
-        "illuminate/routing": "5.3.* || 5.4.* || 5.5.* || 5.6.*",
-        "illuminate/validation": "5.3.* || 5.4.* || 5.5.* || 5.6.*",
-        "illuminate/auth": "5.3.* || 5.4.* || 5.5.* || 5.6.*"
+        "alymosul/exponent-server-sdk-php": "1.1.*",
+        "illuminate/config": "5.3.* || 5.4.* || 5.5.* || 5.6.* || 5.7.*",
+        "illuminate/notifications": "5.3.* || 5.4.* || 5.5.* || 5.6.* || 5.7.*",
+        "illuminate/support": "5.3.* || 5.4.* || 5.5.* || 5.6.* || 5.7.*",
+        "illuminate/events": "5.3.* || 5.4.* || 5.5.* || 5.6.* || 5.7.*",
+        "illuminate/queue": "5.3.* || 5.4.* || 5.5.* || 5.6.* || 5.7.*",
+        "illuminate/http": "5.3.* || 5.4.* || 5.5.* || 5.6.* || 5.7.*",
+        "illuminate/routing": "5.3.* || 5.4.* || 5.5.* || 5.6.* || 5.7.*",
+        "illuminate/validation": "5.3.* || 5.4.* || 5.5.* || 5.6.* || 5.7.*",
+        "illuminate/auth": "5.3.* || 5.4.* || 5.5.* || 5.6.* || 5.7.*"
     },
     "require-dev": {
         "mockery/mockery": "^0.9.5",
-        "phpunit/phpunit": "~6.0"
+        "phpunit/phpunit": "~5.4||~5.7||~6.0||^7.0",
+        "orchestra/testbench": "~3.3||~3.4||~3.5||~3.6||~3.7"
     },
     "autoload": {
         "psr-4": {
@@ -41,5 +43,12 @@
     },
     "config": {
         "sort-packages": true
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "NotificationChannels\\ExpoPushNotifications\\ExpoPushNotificationsServiceProvider"
+            ]
+        }
     }
 }

config/exponent-push-notifications.php

@@ -0,0 +1,17 @@
+<?php
+
+/**
+ * Here you may define the configuration for the expo-notifications-driver.
+ * The expo-notifications-driver can guide the sdk to use `database` or `file` repositories.
+ * The database repository uses the same configuration for the database in your Laravel app.
+ */
+
+return [
+    'interests' => [
+        'driver' => env('EXPONENT_PUSH_NOTIFICATION_INTERESTS_STORAGE_DRIVER', 'file'),
+
+        'database' => [
+            'table_name' => 'exponent_push_notification_interests',
+        ],
+    ],
+];

migrations/create_exponent_push_notification_interests_table.php.stub

@@ -0,0 +1,29 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class CreateExponentPushNotificationInterestsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up()
+    {
+        Schema::create(config('exponent-push-notifications.interests.database.table_name'), function (Blueprint $table) {
+            $table->string('key')->index();
+            $table->string('value');
+
+            $table->unique(['key','value']);
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down()
+    {
+        Schema::drop(config('exponent-push-notifications.interests.database.table_name'));
+    }
+}

phpunit.xml.dist

@@ -22,7 +22,7 @@
     <logging>
         <log type="tap" target="build/report.tap"/>
         <log type="junit" target="build/report.junit.xml"/>
-        <log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
+        <log type="coverage-html" target="build/coverage"/>
         <log type="coverage-text" target="build/coverage.txt"/>
         <log type="coverage-clover" target="build/logs/clover.xml"/>
     </logging>

src/ExpoChannel.php

@@ -3,8 +3,8 @@
 namespace NotificationChannels\ExpoPushNotifications;
 
 use ExponentPhpSDK\Expo;
-use Illuminate\Events\Dispatcher;
 use Illuminate\Notifications\Notification;
+use Illuminate\Contracts\Events\Dispatcher;
 use ExponentPhpSDK\Exceptions\ExpoException;
 use Illuminate\Notifications\Events\NotificationFailed;
 use NotificationChannels\ExpoPushNotifications\Exceptions\CouldNotSendNotification;

src/ExpoPushNotificationsServiceProvider.php

@@ -7,29 +7,88 @@
 use ExponentPhpSDK\ExpoRepository;
 use Illuminate\Support\ServiceProvider;
 use ExponentPhpSDK\Repositories\ExpoFileDriver;
+use NotificationChannels\ExpoPushNotifications\Repositories\ExpoDatabaseDriver;
 
 class ExpoPushNotificationsServiceProvider extends ServiceProvider
 {
     /**
      * Bootstrap the application services.
+     *
+     * @return void
      */
     public function boot()
     {
+        $this->setupConfig();
+
+        $repository = $this->getInterestsDriver();
+
+        $this->shouldPublishMigrations($repository);
+
         $this->app->when(ExpoChannel::class)
             ->needs(Expo::class)
-            ->give(function () {
-                return new Expo(new ExpoRegistrar(new ExpoFileDriver()));
+            ->give(function () use ($repository) {
+                return new Expo(new ExpoRegistrar($repository));
             });
 
-        //Load routes
         $this->loadRoutesFrom(__DIR__.'/Http/routes.php');
     }
 
     /**
      * Register the application services.
+     *
+     * @return void
      */
     public function register()
     {
-        $this->app->bind(ExpoRepository::class, ExpoFileDriver::class);
+        $this->app->bind(ExpoRepository::class, get_class($this->getInterestsDriver()));
+    }
+
+    /**
+     * Gets the Expo repository driver based on config.
+     *
+     * @return ExpoRepository
+     */
+    public function getInterestsDriver()
+    {
+        $driver = config('exponent-push-notifications.interests.driver');
+
+        switch ($driver) {
+            case 'database':
+                return new ExpoDatabaseDriver();
+                break;
+            default:
+                return new ExpoFileDriver();
+        }
+    }
+
+    /**
+     * Publishes the configuration files for the package.
+     *
+     * @return void
+     */
+    protected function setupConfig()
+    {
+        $this->publishes([
+            __DIR__ . '/../config/exponent-push-notifications.php' => config_path('exponent-push-notifications.php'),
+        ], 'config');
+
+        $this->mergeConfigFrom(__DIR__.'/../config/exponent-push-notifications.php', 'exponent-push-notifications');
+    }
+
+    /**
+     * Publishes the migration files needed in the package.
+     *
+     * @param ExpoRepository $repository
+     *
+     * @return void
+     */
+    private function shouldPublishMigrations(ExpoRepository $repository)
+    {
+        if ($repository instanceof ExpoDatabaseDriver && !class_exists('CreateExponentPushNotificationInterestsTable')) {
+            $timestamp = date('Y_m_d_His', time());
+            $this->publishes([
+                __DIR__ . '/../migrations/create_exponent_push_notification_interests_table.php.stub' => database_path("/migrations/{$timestamp}_create_exponent_push_notification_interests_table.php"),
+            ], 'migrations');
+        }
     }
 }

src/Http/ExpoController.php

@@ -72,14 +72,31 @@ public function subscribe(Request $request)
     /**
      * Handles removing subscription endpoint for the authenticated interest.
      *
-     * @return \Illuminate\Http\JsonResponse
+     * @param Request $request
+     *
+     * @return JsonResponse
      */
-    public function unsubscribe()
+    public function unsubscribe(Request $request)
     {
         $interest = $this->expoChannel->interestName(Auth::user());
 
+        $validator = Validator::make($request->all(), [
+            'expo_token'    =>  'sometimes|string',
+        ]);
+
+        if ($validator->fails()) {
+            return JsonResponse::create([
+                'status' => 'failed',
+                'error' => [
+                    'message' => 'Expo Token is invalid',
+                ],
+            ], 422);
+        }
+
+        $token = $request->get('expo_token') ?: null;
+
         try {
-            $deleted = $this->expoChannel->expo->unsubscribe($interest);
+            $deleted = $this->expoChannel->expo->unsubscribe($interest, $token);
         } catch (\Exception $e) {
             return JsonResponse::create([
                 'status'    => 'failed',

src/Http/routes.php

@@ -1,6 +1,6 @@
 <?php
 
-Route::group(['prefix' => 'api/exponent/devices', 'middleware' => 'auth:api, bindings'], function () {
+Route::group(['prefix' => 'api/exponent/devices', 'middleware' => ['auth:api', 'bindings']], function () {
     Route::post('subscribe', [
         'as'    =>  'register-interest',
         'uses'  =>  'NotificationChannels\ExpoPushNotifications\Http\ExpoController@subscribe',

src/Models/Interest.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace NotificationChannels\ExpoPushNotifications\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+class Interest extends Model
+{
+    /**
+     * The associated table.
+     *
+     * @var string
+     */
+    protected $table;
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'key',
+        'value',
+    ];
+
+    /**
+     * Indicates if the model should be timestamped.
+     *
+     * @var bool
+     */
+    public $timestamps = false;
+
+    /**
+     * Interest constructor.
+     *
+     * @param array $attributes
+     */
+    public function __construct(array $attributes = [])
+    {
+        $this->table = config('exponent-push-notifications.interests.database.table_name');
+
+        parent::__construct($attributes);
+    }
+}