Merge branch 'feature/5-response-factory' into release-1.0.0

Close #5

Author: weierophinney

CHANGELOG.md

@@ -2,6 +2,39 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
+## 1.0.0alpha1 - 2018-02-27
+
+### Added
+
+- Nothing.
+
+### Changed
+
+- [#5](https://github.com/zendframework/zend-expressive-authentication-basic/pull/5)
+  changes the constructor of the `Zend\Expressive\Authentication\Basic\BasicAccess`
+  class to accept a callable `$responseFactory` instead of a
+  `Psr\Http\Message\ResponseInterface` response prototype. The
+  `$responseFactory` should produce a `ResponseInterface` implementation when
+  invoked.
+
+- [#5](https://github.com/zendframework/zend-expressive-authentication-basic/pull/5)
+  updates the `BasicAccessFactory` to no longer use
+  `Zend\Expressive\Authentication\ResponsePrototypeTrait`, and instead always
+  depend on the `Psr\Http\Message\ResponseInterface` service to correctly return
+  a PHP callable capable of producing a `ResponseInterface` instance.
+
+### Deprecated
+
+- Nothing.
+
+### Removed
+
+- Nothing.
+
+### Fixed
+
+- Nothing.
+
 ## 0.2.0 - 2018-02-26
 
 ### Added

src/BasicAccess.php

@@ -1,7 +1,7 @@
 <?php
 /**
  * @see       https://github.com/zendframework/zend-expressive-authentication-basic for the canonical source repository
- * @copyright Copyright (c) 2017 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2017-2018 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   https://github.com/zendframework/zend-expressive-authentication-basic/blob/master/LICENSE.md
  *     New BSD License
  */
@@ -27,30 +27,24 @@ class BasicAccess implements AuthenticationInterface
     protected $realm;
 
     /**
-     * @var ResponseInterface
+     * @var callable
      */
-    protected $responsePrototype;
+    protected $responseFactory;
 
-    /**
-     * Constructor
-     *
-     * @param UserRepositoryInterface $repository
-     * @param string $realm
-     * @param ResponseInterface $responsePrototype
-     */
     public function __construct(
         UserRepositoryInterface $repository,
         string $realm,
-        ResponseInterface $responsePrototype
+        callable $responseFactory
     ) {
         $this->repository = $repository;
         $this->realm = $realm;
-        $this->responsePrototype = $responsePrototype;
+
+        // Ensures type safety of the composed factory
+        $this->responseFactory = function () use ($responseFactory) : ResponseInterface {
+            return $responseFactory();
+        };
     }
 
-    /**
-     * {@inheritDoc}
-     */
     public function authenticate(ServerRequestInterface $request) : ?UserInterface
     {
         $authHeader = $request->getHeader('Authorization');
@@ -67,12 +61,9 @@ public function authenticate(ServerRequestInterface $request) : ?UserInterface
         return $this->repository->authenticate($username, $password);
     }
 
-    /**
-     * {@inheritDoc}
-     */
     public function unauthorizedResponse(ServerRequestInterface $request) : ResponseInterface
     {
-        return $this->responsePrototype
+        return ($this->responseFactory)()
             ->withHeader(
                 'WWW-Authenticate',
                 sprintf('Basic realm="%s"', $this->realm)

src/BasicAccessFactory.php

@@ -1,22 +1,20 @@
 <?php
 /**
  * @see       https://github.com/zendframework/zend-expressive-authentication-basic for the canonical source repository
- * @copyright Copyright (c) 2017 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2017-2018 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   https://github.com/zendframework/zend-expressive-authentication-basic/blob/master/LICENSE.md
  *     New BSD License
  */
 
 namespace Zend\Expressive\Authentication\Basic;
 
 use Psr\Container\ContainerInterface;
+use Psr\Http\Message\ResponseInterface;
 use Zend\Expressive\Authentication\Exception;
-use Zend\Expressive\Authentication\ResponsePrototypeTrait;
 use Zend\Expressive\Authentication\UserRepositoryInterface;
 
 class BasicAccessFactory
 {
-    use ResponsePrototypeTrait;
-
     public function __invoke(ContainerInterface $container) : BasicAccess
     {
         $userRegister = $container->has(UserRepositoryInterface::class)
@@ -40,7 +38,7 @@ public function __invoke(ContainerInterface $container) : BasicAccess
         return new BasicAccess(
             $userRegister,
             $realm,
-            $this->getResponsePrototype($container)
+            $container->get(ResponseInterface::class)
         );
     }
 }

test/BasicAccessFactoryTest.php

@@ -1,18 +1,19 @@
 <?php
 /**
  * @see       https://github.com/zendframework/zend-expressive-authentication-basic for the canonical source repository
- * @copyright Copyright (c) 2017 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2017-2018 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   https://github.com/zendframework/zend-expressive-authentication-basic/blob/master/LICENSE.md
  *     New BSD License
  */
 
 namespace ZendTest\Expressive\Authentication\Basic;
 
+use PHPUnit\Framework\Assert;
 use PHPUnit\Framework\TestCase;
-use Prophecy\Argument;
 use Prophecy\Prophecy\ObjectProphecy;
 use Psr\Container\ContainerInterface;
 use Psr\Http\Message\ResponseInterface;
+use ReflectionProperty;
 use Zend\Expressive\Authentication\Basic\BasicAccess;
 use Zend\Expressive\Authentication\Basic\BasicAccessFactory;
 use Zend\Expressive\Authentication\Exception\InvalidConfigException;
@@ -29,6 +30,9 @@ class BasicAccessFactoryTest extends TestCase
     /** @var UserRepositoryInterface|ObjectProphecy */
     private $userRegister;
 
+    /** @var ResponseInterface|ObjectProphecy */
+    private $responsePrototype;
+
     /** @var callback */
     private $responseFactory;
 
@@ -37,8 +41,9 @@ protected function setUp()
         $this->container = $this->prophesize(ContainerInterface::class);
         $this->factory = new BasicAccessFactory();
         $this->userRegister = $this->prophesize(UserRepositoryInterface::class);
+        $this->responsePrototype = $this->prophesize(ResponseInterface::class);
         $this->responseFactory = function () {
-            return $this->prophesize(ResponseInterface::class)->reveal();
+            return $this->responsePrototype->reveal();
         };
     }
 
@@ -92,5 +97,14 @@ public function testInvokeWithContainerAndConfig()
 
         $basicAccess = ($this->factory)($this->container->reveal());
         $this->assertInstanceOf(BasicAccess::class, $basicAccess);
+        $this->assertResponseFactoryReturns($this->responsePrototype->reveal(), $basicAccess);
+    }
+
+    public static function assertResponseFactoryReturns(ResponseInterface $expected, BasicAccess $service) : void
+    {
+        $r = new ReflectionProperty($service, 'responseFactory');
+        $r->setAccessible(true);
+        $responseFactory = $r->getValue($service);
+        Assert::assertSame($expected, $responseFactory());
     }
 }

test/BasicAccessTest.php

@@ -1,7 +1,7 @@
 <?php
 /**
  * @see       https://github.com/zendframework/zend-expressive-authentication-basic for the canonical source repository
- * @copyright Copyright (c) 2017 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2017-2018 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   https://github.com/zendframework/zend-expressive-authentication-basic/blob/master/LICENSE.md
  *     New BSD License
  */
@@ -32,20 +32,26 @@ class BasicAccessTest extends TestCase
     /** @var ResponseInterface|ObjectProphecy */
     private $responsePrototype;
 
+    /** @var callable */
+    private $responseFactory;
+
     protected function setUp()
     {
         $this->request = $this->prophesize(ServerRequestInterface::class);
         $this->userRepository = $this->prophesize(UserRepositoryInterface::class);
         $this->authenticatedUser = $this->prophesize(UserInterface::class);
         $this->responsePrototype = $this->prophesize(ResponseInterface::class);
+        $this->responseFactory = function () {
+            return $this->responsePrototype->reveal();
+        };
     }
 
     public function testConstructor()
     {
         $basicAccess = new BasicAccess(
             $this->userRepository->reveal(),
             'test',
-            $this->responsePrototype->reveal()
+            $this->responseFactory
         );
         $this->assertInstanceOf(AuthenticationInterface::class, $basicAccess);
     }
@@ -59,7 +65,7 @@ public function testIsAuthenticatedWithoutHeader()
         $basicAccess = new BasicAccess(
             $this->userRepository->reveal(),
             'test',
-            $this->responsePrototype->reveal()
+            $this->responseFactory
         );
         $this->assertNull($basicAccess->authenticate($this->request->reveal()));
     }
@@ -73,7 +79,7 @@ public function testIsAuthenticatedWithoutBasic()
         $basicAccess = new BasicAccess(
             $this->userRepository->reveal(),
             'test',
-            $this->responsePrototype->reveal()
+            $this->responseFactory
         );
 
         $this->assertNull($basicAccess->authenticate($this->request->reveal()));
@@ -98,7 +104,7 @@ public function testIsAuthenticatedWithValidCredential()
         $basicAccess = new BasicAccess(
             $this->userRepository->reveal(),
             'test',
-            $this->responsePrototype->reveal()
+            $this->responseFactory
         );
 
         $user = $basicAccess->authenticate($this->request->reveal());
@@ -119,7 +125,7 @@ public function testIsAuthenticatedWithNoCredential()
         $basicAccess = new BasicAccess(
             $this->userRepository->reveal(),
             'test',
-            $this->responsePrototype->reveal()
+            $this->responseFactory
         );
 
         $this->assertNull($basicAccess->authenticate($this->request->reveal()));
@@ -140,7 +146,7 @@ public function testGetUnauthenticatedResponse()
         $basicAccess = new BasicAccess(
             $this->userRepository->reveal(),
             'test',
-            $this->responsePrototype->reveal()
+            $this->responseFactory
         );
 
         $response = $basicAccess->unauthorizedResponse($this->request->reveal());