Add EmailProvider for email only login (FriendsOfSymfony#2781)

* Add EmailProvider for email only login

Feature Request:
FriendsOfSymfony#2768

* Fix TestCase for EmailProvider

Author: devtronic

Resources/config/security.xml

@@ -33,6 +33,10 @@
             <argument type="service" id="fos_user.user_manager" />
         </service>
 
+        <service id="fos_user.user_provider.email" class="FOS\UserBundle\Security\EmailProvider" public="false">
+            <argument type="service" id="fos_user.user_manager" />
+        </service>
+
         <service id="fos_user.security.controller" class="FOS\UserBundle\Controller\SecurityController" public="true">
             <argument type="service" id="security.csrf.token_manager" on-invalid="null" />
             <call method="setContainer">

Security/EmailProvider.php

@@ -0,0 +1,23 @@
+<?php
+
+/*
+ * This file is part of the FOSUserBundle package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\UserBundle\Security;
+
+class EmailProvider extends UserProvider
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function findUser($username)
+    {
+        return $this->userManager->findUserByEmail($username);
+    }
+}

Tests/Security/EmailProviderTest.php

@@ -0,0 +1,126 @@
+<?php
+
+/*
+ * This file is part of the FOSUserBundle package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\UserBundle\Tests\Security;
+
+use FOS\UserBundle\Security\EmailProvider;
+use PHPUnit\Framework\TestCase;
+
+class EmailProviderTest extends TestCase
+{
+    /**
+     * @var \PHPUnit_Framework_MockObject_MockObject
+     */
+    private $userManager;
+
+    /**
+     * @var UserProvider
+     */
+    private $userProvider;
+
+    protected function setUp()
+    {
+        $this->userManager = $this->getMockBuilder('FOS\UserBundle\Model\UserManagerInterface')->getMock();
+        $this->userProvider = new EmailProvider($this->userManager);
+    }
+
+    public function testLoadUserByUsername()
+    {
+        $user = $this->getMockBuilder('FOS\UserBundle\Model\UserInterface')->getMock();
+        $this->userManager->expects($this->once())
+            ->method('findUserByEmail')
+            ->with('foobar')
+            ->will($this->returnValue($user));
+
+        $this->assertSame($user, $this->userProvider->loadUserByUsername('foobar'));
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Security\Core\Exception\UsernameNotFoundException
+     */
+    public function testLoadUserByInvalidUsername()
+    {
+        $this->userManager->expects($this->once())
+            ->method('findUserByEmail')
+            ->with('foobar')
+            ->will($this->returnValue(null));
+
+        $this->userProvider->loadUserByUsername('foobar');
+    }
+
+    public function testRefreshUserBy()
+    {
+        $user = $this->getMockBuilder('FOS\UserBundle\Model\User')
+                    ->setMethods(array('getId'))
+                    ->getMock();
+
+        $user->expects($this->once())
+            ->method('getId')
+            ->will($this->returnValue('123'));
+
+        $refreshedUser = $this->getMockBuilder('FOS\UserBundle\Model\UserInterface')->getMock();
+        $this->userManager->expects($this->once())
+            ->method('findUserBy')
+            ->with(array('id' => '123'))
+            ->will($this->returnValue($refreshedUser));
+
+        $this->userManager->expects($this->atLeastOnce())
+            ->method('getClass')
+            ->will($this->returnValue(get_class($user)));
+
+        $this->assertSame($refreshedUser, $this->userProvider->refreshUser($user));
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Security\Core\Exception\UsernameNotFoundException
+     */
+    public function testRefreshDeleted()
+    {
+        $user = $this->getMockForAbstractClass('FOS\UserBundle\Model\User');
+        $this->userManager->expects($this->once())
+            ->method('findUserBy')
+            ->will($this->returnValue(null));
+
+        $this->userManager->expects($this->atLeastOnce())
+            ->method('getClass')
+            ->will($this->returnValue(get_class($user)));
+
+        $this->userProvider->refreshUser($user);
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Security\Core\Exception\UnsupportedUserException
+     */
+    public function testRefreshInvalidUser()
+    {
+        $user = $this->getMockBuilder('Symfony\Component\Security\Core\User\UserInterface')->getMock();
+        $this->userManager->expects($this->any())
+            ->method('getClass')
+            ->will($this->returnValue(get_class($user)));
+
+        $this->userProvider->refreshUser($user);
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Security\Core\Exception\UnsupportedUserException
+     */
+    public function testRefreshInvalidUserClass()
+    {
+        $user = $this->getMockBuilder('FOS\UserBundle\Model\User')->getMock();
+        $providedUser = $this->getMockBuilder('FOS\UserBundle\Tests\TestUser')->getMock();
+
+        $this->userManager->expects($this->atLeastOnce())
+            ->method('getClass')
+            ->will($this->returnValue(get_class($user)));
+
+        $this->userProvider->refreshUser($providedUser);
+    }
+}