Support additional attributes during registration flow

Author: avvertix

src/Auth/RegistersUsersWithIdentity.php

@@ -7,6 +7,7 @@
 use Illuminate\Http\Response;
 use Illuminate\Support\Facades\Auth;
 use Illuminate\Foundation\Auth\RedirectsUsers;
+use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\DB;
 use Oneofftech\Identities\Facades\IdentityCrypt;
 use Illuminate\Validation\ValidationException;
@@ -29,9 +30,11 @@ public function redirect(Request $request, $provider)
         // probably have the referrer header set
         // and in case of validation errors the
         // referrer has precedence over _previous.url
-        // $request->session()->put('_oot.identities.previous_url', url()->previous());
         $this->savePreviousUrl();
 
+        // get additional user defined attributes
+        $this->pushAttributes($request);
+
         return Identity::driver($provider)
             ->redirectUrl(route('oneofftech::register.callback', ['provider' => $provider]))
             ->redirect();
@@ -65,7 +68,7 @@ public function register(Request $request, $provider)
         /**
          * @var \Illuminate\Contracts\Validation\Validator
          */
-        $validator = $this->validator($this->map($oauthUser));
+        $validator = $this->validator($this->map($request, $oauthUser));
 
         if ($validator->fails()) {
 
@@ -102,13 +105,15 @@ public function register(Request $request, $provider)
      * @param SocialiteUser $oauthUser
      * @return array
      */
-    protected function map(SocialiteUser $oauthUser)
+    protected function map(Request $request, SocialiteUser $oauthUser)
     {
-        return [
+        $user = [
             'name' => $oauthUser->getName() ?? $oauthUser->getNickname(),
             'email' => $oauthUser->getEmail(),
             'avatar' => $oauthUser->getAvatar(),
         ];
+
+        return array_merge($user, $this->pullAttributes($request));
     }
 
     protected function createIdentity($user, $provider, $oauthUser)
@@ -158,4 +163,41 @@ protected function guard()
     {
         return Auth::guard();
     }
+
+    /**
+     * The attributes that should be retrieved from
+     * the request to append to the redirect
+     *
+     * @var array
+     */
+    protected function redirectAttributes()
+    {
+        if (method_exists($this, 'attributes')) {
+            return $this->attributes();
+        }
+
+        return property_exists($this, 'attributes') ? $this->attributes : [];
+    }
+
+    protected function pushAttributes($request)
+    {
+        $attributes = $this->redirectAttributes() ?? [];
+
+        if (empty($attributes)) {
+            return;
+        }
+        
+        $request->session()->put('_oot.identities.attributes', json_encode($request->only($attributes)));
+    }
+
+    protected function pullAttributes($request)
+    {
+        $attributes = $this->redirectAttributes() ?? [];
+
+        if (empty($attributes)) {
+            return [];
+        }
+
+        return json_decode($request->session()->pull('_oot.identities.attributes'), true);
+    }
 }

src/View/Components/IdentityLink.php

@@ -2,6 +2,7 @@
 
 namespace Oneofftech\Identities\View\Components;
 
+use Illuminate\Support\Arr;
 use Illuminate\View\Component;
 use InvalidArgumentException;
 
@@ -35,16 +36,24 @@ class IdentityLink extends Component
      */
     public $label;
 
+    /**
+     * Additional parameters to append on the redirect request
+     *
+     * @var array
+     */
+    public $parameters;
+
     /**
      * Create a new component instance.
      *
      * @param string $provider The identity provider
      * @param string $action The action the button should perform. Available: login, register. Default login.
      * @param string $label The label for the link. It will be used as string to localize.
      *                      Default null a default label in the form "$action via $provider" will be used.
+     * @param array|null $parameter Additional parameters to append on the redirect request
      * @return self
      */
-    public function __construct($provider, $action = 'login', $label = null)
+    public function __construct($provider, $action = 'login', $label = null, $parameters = null)
     {
         if (! in_array($action, self::$availableActions)) {
             throw new InvalidArgumentException("Specified action [$action] is not supported.");
@@ -53,6 +62,7 @@ public function __construct($provider, $action = 'login', $label = null)
         $this->provider = $provider;
         $this->action = $action;
         $this->label = $label ?? (self::$actionLabels[$this->action] ?? ucfirst($action));
+        $this->parameters = Arr::wrap($parameters) ?? [];
     }
 
     /**
@@ -63,7 +73,7 @@ public function __construct($provider, $action = 'login', $label = null)
     public function render()
     {
         return <<<'blade'
-            <a href="{{ route('oneofftech::' . $action . '.provider', ['provider' => $provider]) }}" {{ $attributes }}>
+            <a href="{{ route('oneofftech::' . $action . '.provider', array_merge($parameters, ['provider' => $provider])) }}" {{ $attributes }}>
                 {{ __($label, ['provider' => $provider]) }}
             </a>
         blade;