First commit

Author: bestmomo

README.md

@@ -0,0 +1,99 @@
+## Laravel Email Confirmation ##
+
+This package is to add email confirmation to Laravel 5.4 project.
+
+It should be used after `php artisan make:auth` command but can also be added to existing project.
+
+### Features ###
+
+- create a migration to add confirmation columns to users table
+- create routes for confirmation
+     `confirmation/resend`       
+     `confirmation/{id}/{token}` 
+- add an artisan command to override login and register views
+- send email notification with registration
+- add translations for notification (there are french and english ones)
+- block login for not confirmed user and launch an alert with resend link for notification
+- block auto login on password reset for not confirmed user
+
+### Installation ###
+
+Add package to your composer.json file :
+```
+    composer require bestmomo/laravel-email-confirmation
+```
+
+Add service provider to `config/app.php` :
+```
+    Bestmomo\LaravelEmailConfirmation\ServiceProvider::class,
+```
+
+Make a migration to add columns to users table :
+```
+    php artisan migrate
+```
+
+Change trait reference in `LoginController` :
+```
+    use Bestmomo\LaravelEmailConfirmation\Traits\AuthenticatesUsers;
+```
+
+Change trait reference in `RegisterController` :
+```
+    use Bestmomo\LaravelEmailConfirmation\Traits\RegistersUsers;
+```
+
+Change trait reference in `ResetPasswordController`:
+```
+    use Bestmomo\LaravelEmailConfirmation\Traits\ResetsPasswords;
+```
+
+### Publish ###
+
+- If you have used the `php artisan make:auth` command
+
+Override login and register views to get confirmation alerts :
+```
+    php artisan confirmation:auth
+```
+
+- If you have custom scaffold
+
+You must add alerts in login and register views. Here are 2 examples with Bootstrap.
+
+Login view :
+
+```
+@if (session('confirmation-success'))
+    <div class="alert alert-success">
+        {{ session('confirmation-success') }}
+    </div>
+@endif
+@if (session('confirmation-danger'))
+    <div class="alert alert-danger">
+        {!! session('confirmation-danger') !!}
+    </div>
+@endif
+```
+
+Register view :
+
+```
+@if (session('confirmation-success'))
+    <div class="alert alert-success">
+        {{ session('confirmation-success') }}
+    </div>
+@endif
+```
+
+### Optional Publish ###
+
+If you want to do some changes or add a language you can publish translations :
+```
+    php artisan vendor:publish --tag=confirmation:translations
+```
+
+If you want to do some changes to confirmation notification you can make a copy in App :
+```
+    php artisan confirmation:notification
+```

composer.json

@@ -0,0 +1,22 @@
+{
+  "name": "bestmomo/laravel-email-confirmation",
+  "description": "Email address confirmation with Laravel",
+  "homepage": "http://github.com/laravel-email-confirmation",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Bestmomo",
+      "email": "[email protected]",
+      "homepage":"http://laravel.sillo.org"
+    }
+  ],
+  "require": {
+    "php": ">=5.6.4",
+    "illuminate/support": "~5.4"
+  },
+  "autoload": {
+    "psr-4": {
+      "Bestmomo\\LaravelEmailConfirmation\\": "src/"
+    }
+  }
+}

database/migrations/2017_02_02_232450_add_confirmation.php

@@ -0,0 +1,34 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class AddConfirmation extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::table('users', function (Blueprint $table) {
+            $table->boolean('confirmed')->default(false);
+            $table->string('confirmation_code')->nullable();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::table('users', function (Blueprint $table) {
+            $table->dropColumn('confirmed');
+            $table->dropColumn('confirmation_code');
+        });
+    }
+}

publishable/translations/en/confirmation.php

@@ -0,0 +1,13 @@
+<?php
+
+return [
+    'email-title' => 'Email verification',
+    'email-intro'=> 'To validate your email click on the button below',
+    'email-button' => 'Email verification',
+    'message' => 'Thanks for signing up! Please check your email.',
+    'success' => 'You have successfully verified your account! You can now login.',
+    'again' => 'You must verify your email before you can access the site. ' .
+                '<br>If you have not received the confirmation email check your spam folder.'.
+                '<br>To get a new confirmation email please <a href="' . url('confirmation/resend') . '" class="alert-link">click here</a>.',
+    'resend' => 'A confirmation message has been sent. Please check your email.'
+];

publishable/translations/fr/confirmation.php

@@ -0,0 +1,13 @@
+<?php
+
+return [
+    'email-title' => 'Vérification d\'email',
+    'email-intro' => 'Pour valider votre email cliquez sur le bouton ci-dessous',
+    'email-button' => 'Confirmation d\'email',
+    'message' => 'Merci de vous être enregistré ! Regardez dans vos emails en réception.',
+    'success' => 'Vous avez maintenant confirmé votre compte ! Vous pouvez vous connecter.',
+    'again' => 'Vous devez valider votre email avant de pouvoir accéder à ce site. ' .
+                '<br>Si vous n\'avez pas reçu l\'email de confirmation veuillez consulter votre dossier de spams.' .
+                '<br>Pour recevoir à nouveau un email de confirmation <a href="' . url('confirmation/resend') . '" class="alert-link">cliquez ici</a>.',
+    'resend' => 'Un email de confirmation vous a été envoyé. Regardez dans vos emails en réception.'
+];

routes/web.php

@@ -0,0 +1,5 @@
+<?php
+
+// Email confirmation 
+Route::get('confirmation/resend', 'Auth\RegisterController@resend');
+Route::get('confirmation/{id}/{token}', 'Auth\RegisterController@confirm');

src/Commands/AuthCommand.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace Bestmomo\LaravelEmailConfirmation\Commands;
+
+use Illuminate\Console\Command;
+
+class AuthCommand extends Command
+{
+
+    /**
+     * The console command name.
+     *
+     * @var string
+     */
+    protected $name = 'confirmation:auth';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Scaffold basic login and registration views with confirmation alerts';
+
+    /**
+     * The views that need to be exported.
+     *
+     * @var array
+     */
+    protected $views = [
+        'auth/login.stub' => 'auth/login.blade.php',
+        'auth/register.stub' => 'auth/register.blade.php',
+    ];
+
+    /**
+     * Execute the console command.
+     *
+     * @return void
+     */
+    public function fire()
+    {
+        $this->exportViews();
+
+        $this->info('Authentication scaffolding for confirmation generated successfully.');
+    }
+
+    /**
+     * Export the authentication views.
+     *
+     * @return void
+     */
+    protected function exportViews()
+    {
+        foreach ($this->views as $key => $value) {
+            copy(
+                __DIR__.'/stubs/views/'.$key,
+                base_path('resources/views/'.$value)
+            );
+        }
+    }
+}

src/Commands/NotificationCommand.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace Bestmomo\LaravelEmailConfirmation\Commands;
+
+use Illuminate\Console\GeneratorCommand;
+
+class NotificationCommand extends GeneratorCommand
+{
+    /**
+     * The console command name.
+     *
+     * @var string
+     */
+    protected $name = 'confirmation:notification';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Publish confirmation notification';
+
+    /**
+     * The type of class being generated.
+     *
+     * @var string
+     */
+    protected $type = 'Confirmation Notification';
+
+    /**
+     * Get the stub file for the generator.
+     *
+     * @return string
+     */
+    protected function getStub()
+    {
+        return __DIR__.'/stubs/Notifications/ConfirmEmail.stub';
+    }
+
+    /**
+     * Get the desired class name from the input.
+     *
+     * @return string
+     */
+    protected function getNameInput()
+    {
+        return 'ConfirmEmail';
+    }
+
+    /**
+     * Get the default namespace for the class.
+     *
+     * @param  string  $rootNamespace
+     * @return string
+     */
+    protected function getDefaultNamespace($rootNamespace)
+    {
+        return $rootNamespace.'\Notifications';
+    }
+
+    /**
+     * Get the console command arguments.
+     *
+     * @return array
+     */
+    protected function getArguments()
+    {
+        return [];
+    }
+}

src/Commands/stubs/Notifications/ConfirmEmail.stub

@@ -0,0 +1,39 @@
+<?php
+
+namespace DummyNamespace;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Notifications\Notification;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Notifications\Messages\MailMessage;
+
+class ConfirmEmail extends Notification implements ShouldQueue
+{
+    use Queueable;
+
+    /**
+     * Get the notification's delivery channels.
+     *
+     * @return array
+     */
+    public function via()
+    {
+        return ['mail'];
+    }
+
+    /**
+     * Get the mail representation of the notification.
+     *
+     * @param  mixed  $notifiable
+     * @return \Illuminate\Notifications\Messages\MailMessage
+     */
+    public function toMail($notifiable)
+    {
+        return (new MailMessage)
+            ->subject(__('confirmation::confirmation.email-title'))
+            ->line(__('confirmation::confirmation.email-title'))
+            ->line(__('confirmation::confirmation.email-intro'))
+            ->action(__('confirmation::confirmation.email-button'), 
+                url("confirmation/$notifiable->id/$notifiable->confirmation_code"));
+    }
+}