Enable apply middleware to get transport from value container

Author: ilijastuden

composer.lock

@@ -9,6 +9,8 @@
 namespace ActiveCollab\Authentication\Middleware;
 
 use ActiveCollab\Authentication\AuthenticationResult\Transport\TransportInterface;
+use ActiveCollab\Authentication\ValueContainer\RequestValueContainerInterface;
+use ActiveCollab\ValueContainer\ValueContainerInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 
@@ -18,22 +20,22 @@
 class ApplyAuthenticationMiddleware
 {
     /**
-     * @var string
+     * @var ValueContainerInterface
      */
-    private $request_attribute_name;
+    private $value_container;
 
     /**
      * @var bool
      */
     private $apply_on_exit;
 
     /**
-     * @param string $request_attribute_name
-     * @param bool   $apply_on_exit
+     * @param ValueContainerInterface $value_container
+     * @param bool                    $apply_on_exit
      */
-    public function __construct($request_attribute_name = '', $apply_on_exit = false)
+    public function __construct(ValueContainerInterface $value_container, $apply_on_exit = false)
     {
-        $this->request_attribute_name = $request_attribute_name;
+        $this->value_container = $value_container;
         $this->apply_on_exit = (bool) $apply_on_exit;
     }
 
@@ -92,6 +94,10 @@ private function apply(ServerRequestInterface $request, ResponseInterface $respo
      */
     protected function getTransportFrom(ServerRequestInterface $request)
     {
-        return $this->request_attribute_name ? $request->getAttribute($this->request_attribute_name) : null;
+        if ($this->value_container instanceof RequestValueContainerInterface) {
+            $this->value_container->setRequest($request);
+        }
+
+        return $this->value_container->getValue();
     }
 }

src/Middleware/ApplyAuthenticationMiddleware.php

@@ -0,0 +1,81 @@
+<?php
+
+/*
+ * This file is part of the Active Collab Authentication project.
+ *
+ * (c) A51 doo <[email protected]>. All rights reserved.
+ */
+
+namespace ActiveCollab\Authentication\ValueContainer;
+
+use LogicException;
+use Psr\Http\Message\ServerRequestInterface;
+
+/**
+ * @package ActiveCollab\Authentication\ValueContainer
+ */
+class RequestValueContainer implements RequestValueContainerInterface
+{
+    /**
+     * @var ServerRequestInterface
+     */
+    private $request;
+
+    /**
+     * @var string
+     */
+    private $attribute_name;
+
+    /**
+     * RequestValueContainer constructor.
+     *
+     * @param string $attribute_name
+     */
+    public function __construct($attribute_name)
+    {
+        $this->attribute_name = $attribute_name;
+    }
+
+    /**
+     * @return ServerRequestInterface
+     */
+    public function getRequest()
+    {
+        return $this->request;
+    }
+
+    /**
+     * @param  ServerRequestInterface $request
+     * @return $this
+     */
+    public function &setRequest(ServerRequestInterface $request)
+    {
+        $this->request = $request;
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function hasValue()
+    {
+        if (!$this->getRequest()) {
+            throw new LogicException('Request not set.');
+        }
+
+        return array_key_exists($this->attribute_name, $this->getRequest()->getAttributes());
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getValue()
+    {
+        if (!$this->getRequest()) {
+            throw new LogicException('Request not set.');
+        }
+
+        return $this->request->getAttribute($this->attribute_name);
+    }
+}

src/ValueContainer/RequestValueContainer.php

@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the Active Collab Authentication project.
+ *
+ * (c) A51 doo <[email protected]>. All rights reserved.
+ */
+
+namespace ActiveCollab\Authentication\ValueContainer;
+
+use ActiveCollab\ValueContainer\ValueContainerInterface;
+use Psr\Http\Message\ServerRequestInterface;
+
+/**
+ * @package ActiveCollab\Authentication\ValueContainer
+ */
+interface RequestValueContainerInterface extends ValueContainerInterface
+{
+    /**
+     * @param  ServerRequestInterface $request
+     * @return $this
+     */
+    public function &setRequest(ServerRequestInterface $request);
+}

src/ValueContainer/RequestValueContainerInterface.php

@@ -16,9 +16,12 @@
 use ActiveCollab\Authentication\Test\Session\Repository as SessionRepository;
 use ActiveCollab\Authentication\Test\Session\Session;
 use ActiveCollab\Authentication\Test\TestCase\RequestResponseTestCase;
-use ActiveCollab\Cookies\Adapter\Adapter;
+use ActiveCollab\Authentication\ValueContainer\RequestValueContainer;
 use ActiveCollab\Cookies\Cookies;
 use ActiveCollab\Cookies\CookiesInterface;
+use ActiveCollab\ValueContainer\ValueContainer;
+use ActiveCollab\ValueContainer\ValueContainerInterface;
+use Guzzle\Http\Message\Request;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 
@@ -32,14 +35,20 @@ class ApplyAuthenticationMiddlewareTest extends RequestResponseTestCase
      */
     private $cookies;
 
+    /**
+     * @var ValueContainerInterface
+     */
+    private $value_container;
+
     /**
      * {@inheritdoc}
      */
     public function setUp()
     {
         parent::setUp();
 
-        $this->cookies = new Cookies(new Adapter());
+        $this->cookies = new Cookies();
+        $this->value_container = new ValueContainer();
     }
 
     /**
@@ -61,7 +70,7 @@ public function testUserIsAuthenticated()
         /** @var ServerRequestInterface $request */
         $request = $this->request->withAttribute('test_transport', new AuthorizationTransport($session_adapter, $user, $session, [1, 2, 3]));
 
-        $middleware = new ApplyAuthenticationMiddleware('test_transport');
+        $middleware = new ApplyAuthenticationMiddleware(new RequestValueContainer('test_transport'));
         $this->assertFalse($middleware->applyOnExit());
 
         /** @var ResponseInterface $response */
@@ -82,7 +91,7 @@ public function testUserIsAuthenticated()
     public function testNextIsCalled()
     {
         /** @var ResponseInterface $response */
-        $response = call_user_func(new ApplyAuthenticationMiddleware('test_transport'), $this->request, $this->response, function (ServerRequestInterface $request, ResponseInterface $response, callable $next = null) {
+        $response = call_user_func(new ApplyAuthenticationMiddleware(new RequestValueContainer('test_transport')), $this->request, $this->response, function (ServerRequestInterface $request, ResponseInterface $response, callable $next = null) {
             $response = $response->withHeader('X-Test', 'Yes, found!');
 
             if ($next) {
@@ -115,7 +124,7 @@ public function testUserIsAuthentiatedOnExit()
         /** @var ServerRequestInterface $request */
         $request = $this->request->withAttribute('test_transport', new AuthorizationTransport($session_adapter, $user, $session, [1, 2, 3]));
 
-        $middleware = new ApplyAuthenticationMiddleware('test_transport', true);
+        $middleware = new ApplyAuthenticationMiddleware(new RequestValueContainer('test_transport'), true);
         $this->assertTrue($middleware->applyOnExit());
 
         /** @var ResponseInterface $response */

test/src/ApplyAuthenticationMiddlewareTest.php

@@ -0,0 +1,59 @@
+<?php
+
+/*
+ * This file is part of the Active Collab Authentication project.
+ *
+ * (c) A51 doo <[email protected]>. All rights reserved.
+ */
+
+namespace ActiveCollab\Authentication\Test;
+
+use ActiveCollab\Authentication\Test\TestCase\RequestResponseTestCase;
+use ActiveCollab\Authentication\ValueContainer\RequestValueContainer;
+
+class RequestValueContainerTest extends RequestResponseTestCase
+{
+    /**
+     * @expectedException \LogicException
+     * @expectedExceptionMessage Request not set.
+     */
+    public function testHasValueWithNoRequest()
+    {
+        (new RequestValueContainer('test_key'))->hasValue();
+    }
+
+    public function testHasValue()
+    {
+        $container = new RequestValueContainer('test_key');
+        $container->setRequest($this->request);
+
+        $this->assertFalse($container->hasValue());
+
+        $this->request = $this->request->withAttribute('test_key', 123);
+        $container->setRequest($this->request);
+
+        $this->assertTrue($container->hasValue());
+    }
+
+    /**
+     * @expectedException \LogicException
+     * @expectedExceptionMessage Request not set.
+     */
+    public function testGetValueWithNoRequest()
+    {
+        (new RequestValueContainer('test_key'))->getValue();
+    }
+
+    public function testGetValue()
+    {
+        $container = new RequestValueContainer('test_key');
+        $container->setRequest($this->request);
+
+        $this->assertNull($container->getValue());
+
+        $this->request = $this->request->withAttribute('test_key', 123);
+        $container->setRequest($this->request);
+
+        $this->assertSame(123, $container->getValue());
+    }
+}