handled user creation event. sending mail when creating a new user. added mail package

Author: hasib32

.env.example

@@ -12,3 +12,12 @@ DB_PASSWORD=secret
 
 CACHE_DRIVER=memcached
 QUEUE_DRIVER=sync
+
+MAIL_DRIVER=smtp
+MAIL_HOST=mailtrap.io
+MAIL_PORT=2525
+MAIL_FROM_ADDRESS=[email protected]
+MAIL_FROM_NAME=Your From
+MAIL_USERNAME=yourusername
+MAIL_PASSWORD=yourpassword
+MAIL_ENCRYPTION=tls

app/Events/UserEvents/UserCreatedEvent.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Events\UserEvents;
+
+use App\Events\Event;
+use App\Models\User;
+
+class UserCreatedEvent extends Event
+{
+    /**
+     * Instance of User
+     *
+     * @var User
+     */
+    public $user;
+
+    /**
+     * @param User $user
+     */
+    public function __construct(User $user)
+    {
+        $this->user = $user;
+    }
+}

app/Http/Controllers/UserController.php

@@ -175,13 +175,11 @@ private function storeRequestValidationRules(Request $request)
 
         $requestUser = $request->user();
 
-        // Only admin user can set role.
+        // Only admin user can set admin role.
         if ($requestUser instanceof User && $requestUser->role === User::ADMIN_ROLE) {
             $rules['role'] = 'in:BASIC_USER,ADMIN_USER';
         } else {
-            $request->request->add([
-                'role'  => User::BASIC_ROLE
-            ]);
+            $rules['role'] = 'in:BASIC_USER';
         }
 
         return $rules;
@@ -214,13 +212,11 @@ private function updateRequestValidationRules(Request $request)
 
         $requestUser = $request->user();
 
-        // Only admin user can update role.
+        // Only admin user can update admin role.
         if ($requestUser instanceof User && $requestUser->role === User::ADMIN_ROLE) {
             $rules['role'] = 'in:BASIC_USER,ADMIN_USER';
         } else {
-            $request->request->add([
-                'role'  => User::BASIC_ROLE
-            ]);
+            $rules['role'] = 'in:BASIC_USER';
         }
 
         return $rules;

app/Listeners/UserEventsListener.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace App\Listeners;
+
+use Illuminate\Events\Dispatcher;
+use App\Events\UserEvents\UserCreatedEvent;
+use App\Mails\WelcomeEmail;
+
+class UserEventsListener
+{
+    /**
+     * Handle the user created event
+     *
+     * @param UserCreatedEvent $event
+     */
+    public function onUserCreatedEvent($event)
+    {
+        $user = $event->user;
+
+        //send welcome email to the user
+        \Mail::to($user)->send(new WelcomeEmail($user));
+    }
+
+    /**
+     * Register the listeners for the subscriber.
+     *
+     * @param Dispatcher $events
+     */
+    public function subscribe($events)
+    {
+        $events->listen(
+            UserCreatedEvent::class,
+            'App\Listeners\UserEventsListener@onUserCreatedEvent'
+        );
+    }
+}

app/Mails/WelcomeEmail.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace App\Mails;
+
+use App\Models\User;
+use Illuminate\Bus\Queueable;
+use Illuminate\Mail\Mailable;
+use Illuminate\Queue\SerializesModels;
+
+class WelcomeEmail extends Mailable
+{
+    use Queueable, SerializesModels;
+
+    /**
+     * Instance of User
+     *
+     * @var User
+     */
+    public $user;
+
+    /**
+     * Create a new message instance.
+     *
+     * @param User $user
+     */
+    public function __construct(User $user)
+    {
+        $this->user = $user;
+    }
+
+    /**
+     * Build the message.
+     *
+     * @return $this
+     */
+    public function build()
+    {
+        return $this->view('emails.welcome');
+    }
+}

app/Providers/EventServiceProvider.php

@@ -3,6 +3,7 @@
 namespace App\Providers;
 
 use Laravel\Lumen\Providers\EventServiceProvider as ServiceProvider;
+use App\Listeners\UserEventsListener;
 
 class EventServiceProvider extends ServiceProvider
 {
@@ -16,4 +17,13 @@ class EventServiceProvider extends ServiceProvider
             'App\Listeners\EventListener',
         ],
     ];
+
+    /**
+     * The subscriber classes to register.
+     *
+     * @var array
+     */
+    protected $subscribe = [
+        UserEventsListener::class,
+    ];
 }

app/Repositories/AbstractEloquentRepository.php

@@ -5,6 +5,7 @@
 use App\Repositories\Contracts\BaseRepository;
 use Illuminate\Database\Eloquent\Model;
 use Ramsey\Uuid\Uuid;
+use App\Models\User;
 
 abstract class AbstractEloquentRepository implements BaseRepository
 {
@@ -22,10 +23,20 @@ abstract class AbstractEloquentRepository implements BaseRepository
      */
     protected $model;
 
+    /**
+     * get logged in user
+     *
+     * @var User $loggedInUser
+     */
+    protected $loggedInUser;
 
+    /**
+     * Constructor
+     */
     public function __construct()
     {
         $this->setModel();
+        $this->loggedInUser = $this->getLoggedInUser();
     }
 
     /**
@@ -181,7 +192,12 @@ public function delete(Model $model)
      */
     protected function getLoggedInUser()
     {
-        return \Auth::user();
-    }
+        $user = \Auth::user();
 
+        if ($user instanceof User) {
+            return $user;
+        } else {
+            return new User();
+        }
+    }
 }

app/Repositories/EloquentUserRepository.php

@@ -6,6 +6,7 @@
 use App\Models\User;
 use Illuminate\Support\Facades\Hash;
 use Illuminate\Database\Eloquent\Model;
+use App\Events\UserEvents\UserCreatedEvent;
 
 class EloquentUserRepository extends AbstractEloquentRepository implements UserRepository
 {
@@ -29,6 +30,9 @@ public function save(array $data)
 
         $user = parent::save($data);
 
+        // fire user created event
+        \Event::fire(new UserCreatedEvent($user));
+
         return $user;
     }
 
@@ -45,4 +49,29 @@ public function update(Model $model, array $data)
 
         return $updatedUser;
     }
+
+    /**
+     * @inheritdoc
+     */
+    public function findBy(array $searchCriteria = [])
+    {
+        // Only admin user can see all users
+        if ($this->loggedInUser->role !== User::ADMIN_ROLE) {
+            $searchCriteria['id'] = $this->loggedInUser->id;
+        }
+
+        return parent::findBy($searchCriteria);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function findOne($id)
+    {
+        if ($id === 'me') {
+            return $this->getLoggedInUser();
+        }
+
+        return parent::findOne($id);
+    }
 }

bootstrap/app.php

@@ -51,6 +51,10 @@
 // load cors configurations
 $app->configure('cors');
 
+// mail configurations
+$app->configure('mail');
+class_alias('Illuminate\Support\Facades\Mail', 'mail');
+
 /*
 |--------------------------------------------------------------------------
 | Register Middleware
@@ -83,11 +87,12 @@
 
 // $app->register(App\Providers\AppServiceProvider::class);
 $app->register(App\Providers\AuthServiceProvider::class);
-// $app->register(App\Providers\EventServiceProvider::class);
+$app->register(App\Providers\EventServiceProvider::class);
 $app->register(App\Providers\RepositoriesServiceProvider::class);
 $app->register(Laravel\Passport\PassportServiceProvider::class);
 $app->register(Dusterio\LumenPassport\PassportServiceProvider::class);
 $app->register(Barryvdh\Cors\LumenServiceProvider::class);
+$app->register(\Illuminate\Mail\MailServiceProvider::class);
 
 /*
 |--------------------------------------------------------------------------

composer.json

@@ -11,7 +11,8 @@
         "ramsey/uuid": "^3.5",
         "league/fractal": "^0.15.0",
         "dusterio/lumen-passport": "^0.1.9",
-        "barryvdh/laravel-cors": "^0.8.6"
+        "barryvdh/laravel-cors": "^0.8.6",
+        "illuminate/mail": "^5.4"
     },
     "require-dev": {
         "fzaninotto/faker": "~1.4",