🎨 Formatting

Author: williamcruzme

Diff for: CONTRIBUTING.md

@@ -19,12 +19,11 @@ composer install
 
 As you can see we have:
 
+- `database`: contains the migrations, seeders or factories.
 - `src` contains the working code for the repository:
-  - `database`: contains the migrations, seeders or factories.
   - `Facades`: contains the package facades.
   - `Helpers`: contains the package helpers.
   - `Http`: contains the http utilities like controllers, requests, etc.
-  - `Traits`: contains the traits to import in the models.
 
 ### Issues
 

Diff for: README.md

@@ -35,7 +35,7 @@ In your user model add the `Notifiable` trait. This trait supports custom guards
 namespace App;
 
 use Illuminate\Foundation\Auth\User as Authenticatable;
-use williamcruzme\NotificationSettings\Traits\Notifiable;
+use Millions\Notifications\Notifiable;
 
 class User extends Authenticatable
 {
@@ -103,7 +103,7 @@ $user->notify(new InvoicePaid($invoice));
 Alternatively, you may send notifications via the `Notification` facade. This is useful primarily when you need to send a notification to multiple notifiable entities such as a collection of users. To send notifications using the facade, pass all of the notifiable entities and the notification instance to the `send` method:
 
 ```php
-use williamcruzme\NotificationSettings\Facades\Notification;
+use Millions\Notifications\Facades\Notification;
 
 Notification::send($users, new InvoicePaid($invoice));
 ```
@@ -120,7 +120,7 @@ Notification::send($users, new InvoicePaid($invoice));
 
 | Method |             URI             |
 | ------ | --------------------------- |
-| PATCH  | `/notifications/markAsRead` |
+| PATCH  | `/notifications/read` |
 
 ### Delete notification
 
@@ -150,12 +150,12 @@ Notification::send($users, new InvoicePaid($invoice));
 
 ## 🎨 Customizing
 
-First of all, create your own `NotificationController` `NotificationSettingController` controllers and add the `ManageNotifications` `ManageNotificationSettings` traits.
+First of all, create your own `NotificationSettingController` controllers and add the `ManageNotificationSettings` trait.
 
 Second, modify the namespace of the `Notification` facade routes:
 
 ```php
-Notification::routes('App\Http\Controllers');
+Notification::routesForSettings('App\Http\Controllers');
 ```
 
 ### Custom request validations
@@ -167,7 +167,7 @@ The `rules` `validationErrorMessages` methods in the `NotificationSettingControl
 
 namespace App\Http\Controllers;
 
-use williamcruzme\NotificationSettings\Traits\ManageNotificationSettings;
+use Millions\Notifications\ManageNotificationSettings;
 
 class NotificationSettingController extends Controller {
 
@@ -199,18 +199,18 @@ class NotificationSettingController extends Controller {
 
 ### Custom response
 
-The `sendResponse` method in the `NotificationController` `NotificationSettingController` allows you override the default response:
+The `sendResponse` method in the `NotificationSettingController` allows you override the default response:
 
 ```php
 <?php
 
 namespace App\Http\Controllers;
 
-use williamcruzme\NotificationSettings\Traits\ManageNotifications;
+use Millions\Notifications\ManageNotificationSettings;
 
-class NotificationController extends Controller {
+class NotificationSettingController extends Controller {
 
-    use ManageNotifications;
+    use ManageNotificationSettings;
 
     /**
      * Get the response for a successful listing notification settings.
@@ -227,18 +227,18 @@ class NotificationController extends Controller {
 
 ### Custom guards
 
-The `guard` method in the `NotificationController` `NotificationSettingController` allows you override the default guard:
+The `guard` method in the `NotificationSettingController` allows you override the default guard:
 
 ```php
 <?php
 
 namespace App\Http\Controllers;
 
-use williamcruzme\NotificationSettings\Traits\ManageNotifications;
+use Millions\Notifications\ManageNotificationSettings;
 
-class NotificationController extends Controller {
+class NotificationSettingController extends Controller {
 
-    use ManageNotifications;
+    use ManageNotificationSettings;
 
     /**
      * Get the guard to be used during notifications management.

Diff for: composer.json

@@ -25,16 +25,16 @@
   "extra": {
     "laravel": {
       "providers": [
-        "williamcruzme\\NotificationSettings\\NotificationServiceProvider"
+        "Millions\\Notifications\\NotificationServiceProvider"
       ],
       "aliases": {
-        "Notification": "williamcruzme\\NotificationSettings\\Facades\\Notification"
+        "Notification": "Millions\\Notifications\\Facades\\Notification"
       }
     }
   },
   "autoload": {
     "psr-4": {
-      "williamcruzme\\NotificationSettings\\": "src/"
+      "Millions\\Notifications\\": "src/"
     }
   }
 }

Diff for: src/database/migrations/2019_07_12_194431_create_notification_types_table.php renamed to database/migrations/2019_07_12_194431_create_notification_types_table.php

@@ -1,8 +1,8 @@
 <?php
 
-use Illuminate\Support\Facades\Schema;
-use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
 
 class CreateNotificationTypesTable extends Migration
 {
@@ -15,8 +15,9 @@ public function up()
     {
         Schema::create('notification_types', function (Blueprint $table) {
             $table->bigIncrements('id');
-            $table->string('name');
+            $table->string('name')->unique();
             $table->string('display_text');
+            $table->json('schedule')->nullabe();
             $table->boolean('status')->default(true);
         });
     }

Diff for: src/database/migrations/2019_07_15_152649_create_notification_settings_table.php renamed to database/migrations/2019_07_15_152649_create_notification_settings_table.php

@@ -1,8 +1,8 @@
 <?php
 
-use Illuminate\Support\Facades\Schema;
-use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
 
 class CreateNotificationSettingsTable extends Migration
 {

Diff for: src/Facades/Notification.php

@@ -1,9 +1,9 @@
 <?php
 
-namespace williamcruzme\NotificationSettings\Facades;
+namespace Millions\Notifications\Facades;
 
-use Illuminate\Support\Facades\Route;
 use Illuminate\Support\Facades\Facade;
+use Illuminate\Support\Facades\Route;
 
 class Notification extends Facade
 {
@@ -22,21 +22,15 @@ protected static function getFacadeAccessor()
      *
      * @return void
      */
-    public static function routes($namespace = '\\williamcruzme\\NotificationSettings\\Http\\Controllers')
+    public static function routesForSettings($namespace = '\\Millions\\Notifications\\Http\\Controllers')
     {
-        Route::namespace($namespace)->group(function () {
-            // Notifications
-            Route::prefix('notifications')->group(function () {
-                Route::get('/', 'NotificationController@index');
-                Route::patch('/markAsRead', 'NotificationController@markAsRead');
-                Route::delete('/', 'NotificationController@destroy');
-            });
+        if (! str_starts_with('\\', $namespace)) {
+            $namespace = "\\$namespace";
+        }
 
-            // Notification Settings
-            Route::prefix('settings/notifications')->group(function () {
-                Route::get('/', 'NotificationSettingController@index');
-                Route::patch('/{notificationType}', 'NotificationSettingController@update');
-            });
+        Route::prefix('settings/notifications')->namespace($namespace)->group(function () {
+            Route::get('/', 'NotificationSettingController@index');
+            Route::patch('{notificationType}', 'NotificationSettingController@update');
         });
     }
 }

Diff for: src/Helpers/Notification.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace williamcruzme\NotificationSettings\Helpers;
+namespace Millions\Notifications\Helpers;
 
 use Illuminate\Notifications\ChannelManager;
 

Diff for: src/Http/Controllers/NotificationController.php

@@ -1,9 +1,9 @@
 <?php
 
-namespace williamcruzme\NotificationSettings\Http\Controllers;
+namespace Millions\Notifications\Http\Controllers;
 
 use App\Http\Controllers\Controller;
-use williamcruzme\NotificationSettings\Traits\ManageNotificationSettings;
+use Millions\Notifications\ManageNotificationSettings;
 
 class NotificationSettingController extends Controller
 {

Diff for: src/Http/Controllers/NotificationSettingController.php

@@ -1,9 +1,9 @@
 <?php
 
-namespace williamcruzme\NotificationSettings\Traits;
+namespace Millions\Notifications;
 
 use Illuminate\Http\Request;
-use williamcruzme\NotificationSettings\NotificationType;
+use Millions\Notifications\NotificationType;
 
 trait ManageNotificationSettings
 {
@@ -14,8 +14,8 @@ trait ManageNotificationSettings
      */
     public function index()
     {
-        $types = NotificationType::get();
-        $settings = $this->guard()->user()->notification_settings;
+        $types = NotificationType::all();
+        $settings = $this->guard()->user()->notificationSettings;
 
         $types->each(function ($type) use ($settings) {
             $setting = $settings->find($type->id);
@@ -29,15 +29,15 @@ public function index()
      * Update the specified resource in storage.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @param  \williamcruzme\FCM\NotificationType  $notificationType
+     * @param  \Millions\Notifications\NotificationType  $notificationType
      * @return \Illuminate\Http\JsonResponse
      */
     public function update(Request $request, NotificationType $notificationType)
     {
         $request->validate($this->rules(), $this->validationErrorMessages());
 
-        $this->guard()->user()->notification_settings()->syncWithoutDetaching([
-            $notificationType->id => $request->only('status'),
+        $this->guard()->user()->notificationSettings()->syncWithoutDetaching([
+            $notificationType->id => $request->boolean('status'),
         ]);
 
         return response()->json([

Diff for: src/Traits/ManageNotificationSettings.php renamed to src/ManageNotificationSettings.php

@@ -1,9 +1,9 @@
 <?php
 
-namespace williamcruzme\NotificationSettings\Traits;
+namespace Millions\Notifications;
 
-use williamcruzme\NotificationSettings\NotificationType;
 use Illuminate\Notifications\Notifiable as BaseNotifiable;
+use Millions\Notifications\NotificationType;
 
 trait Notifiable
 {
@@ -45,7 +45,7 @@ public function notifyNow($instance, array $channels = null)
 
     public function canReceive($notification)
     {
-        $setting = $this->notification_settings()->whereName($notification)->first();
+        $setting = $this->notificationSettings()->whereName($notification)->first();
 
         // Ensure that user wants recieve the notification
         return !$setting || ($setting && $setting->status && $setting->pivot->status);
@@ -56,7 +56,7 @@ public function canReceive($notification)
      *
      * @return \Illuminate\Database\Eloquent\Relations\MorphToMany
      */
-    public function notification_settings()
+    public function notificationSettings()
     {
         return $this
             ->morphToMany(NotificationType::class, 'user', 'notification_settings')

Diff for: src/Traits/Notifiable.php renamed to src/Notifiable.php

@@ -1,9 +1,9 @@
 <?php
 
-namespace williamcruzme\NotificationSettings;
+namespace Millions\Notifications;
 
 use Illuminate\Support\ServiceProvider;
-use williamcruzme\NotificationSettings\Helpers\Notification;
+use Millions\Notifications\Helpers\Notification;
 
 class NotificationServiceProvider extends ServiceProvider
 {
@@ -41,7 +41,7 @@ public function boot()
     protected function bootForConsole()
     {
         $this->publishes([
-            __DIR__.'/database/migrations' => database_path('migrations')
+            __DIR__ . '/../database/migrations' => database_path('migrations')
         ], 'migrations');
     }
 }

Diff for: src/NotificationServiceProvider.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace williamcruzme\NotificationSettings;
+namespace Millions\Notifications;
 
 use Illuminate\Database\Eloquent\Model;
 
@@ -19,7 +19,10 @@ class NotificationType extends Model
      * @var array
      */
     protected $fillable = [
-        'name', 'display_text', 'status',
+        'name',
+        'display_text',
+        'schedule',
+        'status',
     ];
 
     /**
@@ -28,6 +31,7 @@ class NotificationType extends Model
      * @var array
      */
     protected $casts = [
+        'schedule' => 'array',
         'status' => 'boolean',
     ];
 }