Merge pull request #52 from joselfonseca/feature/37-email-verification

Feature: #37 email verification

Author: joselfonseca

config/config.php

@@ -51,5 +51,16 @@
     |
     */
     'migrations' => true,
+    /*
+    |--------------------------------------------------------------------------
+    | Settings for email verification
+    |--------------------------------------------------------------------------
+    |
+    | Update this values for your use case
+    |
+    */
+    'verify_email' => [
+        'base_url' => env('FRONT_URL').'/email-verify',
+    ],
 
 ];

graphql/auth.graphql

@@ -14,11 +14,11 @@ type User {
 }
 
 type AuthPayload {
-    access_token: String!
-    refresh_token: String!
-    expires_in: Int!
-    token_type: String!
-    user: User!
+    access_token: String
+    refresh_token: String
+    expires_in: Int
+    token_type: String
+    user: User
 }
 
 type RefreshTokenPayload {
@@ -38,6 +38,16 @@ type ForgotPasswordResponse {
     message: String
 }
 
+type RegisterResponse {
+    tokens: AuthPayload
+    status: RegisterStatuses!
+}
+
+enum RegisterStatuses {
+    MUST_VERIFY_EMAIL
+    SUCCESS
+}
+
 input ForgotPasswordInput {
     email: String! @rules(apply: ["required", "email"])
 }
@@ -51,7 +61,7 @@ input NewPasswordWithCodeInput {
 
 input RegisterInput {
     name: String! @rules(apply: ["required", "string"])
-    email: String! @rules(apply: ["required", "email"])
+    email: String! @rules(apply: ["required", "email", "unique:users,email"])
     password: String! @rules(apply: ["required", "confirmed", "min:8"])
     password_confirmation: String!
 }
@@ -61,12 +71,17 @@ input SocialLoginInput {
     token: String! @rules(apply: ["required"])
 }
 
+input VerifyEmailInput {
+    token: String!
+}
+
 extend type Mutation {
     login(input: LoginInput @spread): AuthPayload! @field(resolver: "Joselfonseca\\LighthouseGraphQLPassport\\GraphQL\\Mutations\\Login@resolve")
     refreshToken(input: RefreshTokenInput @spread): RefreshTokenPayload! @field(resolver: "Joselfonseca\\LighthouseGraphQLPassport\\GraphQL\\Mutations\\RefreshToken@resolve")
     logout: LogoutResponse! @field(resolver: "Joselfonseca\\LighthouseGraphQLPassport\\GraphQL\\Mutations\\Logout@resolve")
     forgotPassword(input: ForgotPasswordInput! @spread): ForgotPasswordResponse! @field(resolver: "Joselfonseca\\LighthouseGraphQLPassport\\GraphQL\\Mutations\\ForgotPassword@resolve")
     updateForgottenPassword(input: NewPasswordWithCodeInput @spread): ForgotPasswordResponse! @field(resolver: "Joselfonseca\\LighthouseGraphQLPassport\\GraphQL\\Mutations\\ResetPassword@resolve")
-    register(input: RegisterInput @spread): AuthPayload! @field(resolver: "Joselfonseca\\LighthouseGraphQLPassport\\GraphQL\\Mutations\\Register@resolve")
+    register(input: RegisterInput @spread): RegisterResponse! @field(resolver: "Joselfonseca\\LighthouseGraphQLPassport\\GraphQL\\Mutations\\Register@resolve")
     socialLogin(input: SocialLoginInput! @spread): AuthPayload! @field(resolver: "Joselfonseca\\LighthouseGraphQLPassport\\GraphQL\\Mutations\\SocialLogin@resolve")
+    verifyEmail(input: VerifyEmailInput! @spread): AuthPayload! @field(resolver: "Joselfonseca\\LighthouseGraphQLPassport\\GraphQL\\Mutations\\VerifyEmail@resolve")
 }

readme.md

@@ -56,11 +56,11 @@ type User {
 }
 
 type AuthPayload {
-    access_token: String!
-    refresh_token: String!
-    expires_in: Int!
-    token_type: String!
-    user: User!
+    access_token: String
+    refresh_token: String
+    expires_in: Int
+    token_type: String
+    user: User
 }
 
 type RefreshTokenPayload {
@@ -80,6 +80,16 @@ type ForgotPasswordResponse {
     message: String
 }
 
+type RegisterResponse {
+    tokens: AuthPayload
+    status: RegisterStatuses!
+}
+
+enum RegisterStatuses {
+    MUST_VERIFY_EMAIL
+    SUCCESS
+}
+
 input ForgotPasswordInput {
     email: String! @rules(apply: ["required", "email"])
 }
@@ -97,11 +107,15 @@ input RegisterInput {
     password: String! @rules(apply: ["required", "confirmed", "min:8"])
     password_confirmation: String!
 }
+
 input SocialLoginInput {
     provider: String! @rules(apply: ["required"])
     token: String! @rules(apply: ["required"])
 }
 
+input VerifyEmailInput {
+    token: String!
+}
 
 extend type Mutation {
     login(input: LoginInput @spread): AuthPayload! @field(resolver: "Joselfonseca\\LighthouseGraphQLPassport\\GraphQL\\Mutations\\Login@resolve")
@@ -111,6 +125,7 @@ extend type Mutation {
     updateForgottenPassword(input: NewPasswordWithCodeInput @spread): ForgotPasswordResponse! @field(resolver: "Joselfonseca\\LighthouseGraphQLPassport\\GraphQL\\Mutations\\ResetPassword@resolve")
     register(input: RegisterInput @spread): AuthPayload! @field(resolver: "Joselfonseca\\LighthouseGraphQLPassport\\GraphQL\\Mutations\\Register@resolve")
     socialLogin(input: SocialLoginInput! @spread): AuthPayload @field(resolver: "Joselfonseca\\LighthouseGraphQLPassport\\GraphQL\\Mutations\\SocialLogin@resolve")
+    verifyEmail(input: VerifyEmailInput! @spread): AuthPayload! @field(resolver: "Joselfonseca\\LighthouseGraphQLPassport\\GraphQL\\Mutations\\VerifyEmail@resolve")
 }
 ```
 
@@ -133,7 +148,7 @@ This will allow you to change the schema and resolvers if needed.
 
 ## Usage
 
-This will add 7 mutations to your GraphQL API
+This will add 8 mutations to your GraphQL API
 
 ```js
 extend type Mutation {
@@ -144,6 +159,7 @@ extend type Mutation {
     updateForgottenPassword(input: NewPasswordWithCodeInput): ForgotPasswordResponse!
     register(input: RegisterInput @spread): AuthPayload!
     socialLogin(input: SocialLoginInput! @spread): AuthPayload!
+    verifyEmail(input: VerifyEmailInput! @spread): AuthPayload!
 }
 ```
 
@@ -154,6 +170,46 @@ extend type Mutation {
 - **updateForgottenPassword:** Will allow your clients to update the forgotten password from the email received.
 - **register:** Will allow your clients to register a new user using the default Laravel registration fields
 - **socialLogin:** Will allow your clients to log in using access token from social providers using socialite
+- **verifyEmail:** Will allow your clients to verify the email after they receive a token in the email
+
+### Using the email verification
+
+If you want to use the email verification feature that comes with laravel, please follow the instruction in the laravel documentation to configure the model in [https://laravel.com/docs/6.x/verification](https://laravel.com/docs/6.x/verification), once that is done add the following traits
+
+```php
+use Illuminate\Contracts\Auth\MustVerifyEmail;
+use Joselfonseca\LighthouseGraphQLPassport\HasLoggedInTokens;
+use Joselfonseca\LighthouseGraphQLPassport\MustVerifyEmailGraphQL;
+
+class User extends Authenticatable implements MustVerifyEmail
+{
+    use Notifiable;
+    use HasApiTokens;
+    use HasSocialLogin;
+    use MustVerifyEmailGraphQL;
+    use HasLoggedInTokens;
+}
+```
+This will add some methods for the email notification to be sent with a token. Use the token in the following mutation.
+
+```js
+{
+  mutation {
+      verifyEmail(input: {
+          "token": "HERE_THE_TOKEN"
+      }) {
+          access_token
+          refresh_token
+          user {
+              id
+              name
+              email
+          }
+      }
+  }
+}
+```   
+If the token is valid the tokens will be issued.
 
 ### Using socialite for social login
 

src/GraphQL/Mutations/Register.php

@@ -4,6 +4,7 @@
 
 use GraphQL\Type\Definition\ResolveInfo;
 use Illuminate\Auth\Events\Registered;
+use Illuminate\Contracts\Auth\MustVerifyEmail;
 use Illuminate\Support\Facades\Hash;
 use Nuwave\Lighthouse\Support\Contracts\GraphQLContext;
 
@@ -26,6 +27,14 @@ public function resolve($rootValue, array $args, GraphQLContext $context = null,
         $input['password'] = Hash::make($input['password']);
         $model->fill($input);
         $model->save();
+        if ($model instanceof MustVerifyEmail) {
+            $model->sendEmailVerificationNotification();
+
+            return [
+                'tokens' => [],
+                'status' => 'MUST_VERIFY_EMAIL',
+            ];
+        }
         $credentials = $this->buildCredentials([
             'username' => $args[config('lighthouse-graphql-passport.username')],
             'password' => $args['password'],
@@ -35,6 +44,9 @@ public function resolve($rootValue, array $args, GraphQLContext $context = null,
         $response['user'] = $user;
         event(new Registered($user));
 
-        return $response;
+        return [
+            'tokens' => $response,
+            'status' => 'SUCCESS',
+        ];
     }
 }

src/GraphQL/Mutations/VerifyEmail.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace Joselfonseca\LighthouseGraphQLPassport\GraphQL\Mutations;
+
+use GraphQL\Type\Definition\ResolveInfo;
+use Illuminate\Auth\Events\Verified;
+use Illuminate\Database\Eloquent\ModelNotFoundException;
+use Illuminate\Support\Carbon;
+use Illuminate\Support\Facades\Auth;
+use Joselfonseca\LighthouseGraphQLPassport\Exceptions\ValidationException;
+use Nuwave\Lighthouse\Support\Contracts\GraphQLContext;
+
+class VerifyEmail
+{
+    /**
+     * @param $rootValue
+     * @param array                                                    $args
+     * @param \Nuwave\Lighthouse\Support\Contracts\GraphQLContext|null $context
+     * @param \GraphQL\Type\Definition\ResolveInfo                     $resolveInfo
+     *
+     * @throws \Exception
+     *
+     * @return array
+     */
+    public function resolve($rootValue, array $args, GraphQLContext $context = null, ResolveInfo $resolveInfo)
+    {
+        $decodedToken = json_decode(base64_decode($args['token']));
+        $expiration = decrypt($decodedToken->expiration);
+        $email = decrypt($decodedToken->hash);
+        if (Carbon::parse($expiration) < now()) {
+            throw new ValidationException([
+                'token' => 'The token is invalid',
+            ], 'Validation Error');
+        }
+        $model = app(config('auth.providers.users.model'));
+
+        try {
+            $user = $model->where('email', $email)->firstOrFail();
+            $user->markEmailAsVerified();
+            event(new Verified($user));
+            Auth::onceUsingId($user->id);
+            $tokens = $user->getTokens();
+            $tokens['user'] = $user;
+
+            return $tokens;
+        } catch (ModelNotFoundException $e) {
+            throw new ValidationException([
+                'token' => 'The token is invalid',
+            ], 'Validation Error');
+        }
+    }
+}

src/HasLoggedInTokens.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Joselfonseca\LighthouseGraphQLPassport;
+
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Auth;
+
+trait HasLoggedInTokens
+{
+    /**
+     * @throws \Exception
+     *
+     * @return mixed
+     */
+    public function getTokens()
+    {
+        $request = Request::create('oauth/token', 'POST', [
+            'grant_type'    => 'logged_in_grant',
+            'client_id'     => config('lighthouse-graphql-passport.client_id'),
+            'client_secret' => config('lighthouse-graphql-passport.client_secret'),
+        ], [], [], [
+            'HTTP_Accept' => 'application/json',
+        ]);
+        $response = app()->handle($request);
+
+        return json_decode($response->getContent(), true);
+    }
+
+    /**
+     * @param $request
+     *
+     * @return mixed
+     */
+    public function byLoggedInUser($request)
+    {
+        return Auth::user();
+    }
+}

src/MustVerifyEmailGraphQL.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Joselfonseca\LighthouseGraphQLPassport;
+
+use Joselfonseca\LighthouseGraphQLPassport\Notifications\VerifyEmail;
+
+trait MustVerifyEmailGraphQL
+{
+    /**
+     * Send the email verification notification.
+     *
+     * @return void
+     */
+    public function sendEmailVerificationNotification()
+    {
+        $this->notify(new VerifyEmail());
+    }
+}

src/Notifications/VerifyEmail.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Joselfonseca\LighthouseGraphQLPassport\Notifications;
+
+use Illuminate\Support\Carbon;
+
+class VerifyEmail extends \Illuminate\Auth\Notifications\VerifyEmail
+{
+    /**
+     * Get the verification URL for the given notifiable.
+     *
+     * @param mixed $notifiable
+     *
+     * @return string
+     */
+    protected function verificationUrl($notifiable)
+    {
+        $payload = base64_encode(json_encode([
+            'id'         => $notifiable->getKey(),
+            'hash'       => encrypt($notifiable->getEmailForVerification()),
+            'expiration' => encrypt(Carbon::now()->addMinutes(10)->toIso8601String()),
+        ]));
+
+        return config('lighthouse-graphql-passport.verify_email.base_url').'?token='.$payload;
+    }
+}