Rename back authentication_result with authenticated_with

perajovic · perajovic · commit 331cffc53c37 · 2016-04-25T15:47:31.000+02:00
diff --git a/composer.lock b/composer.lock
diff --git a/src/Adapter/AdapterInterface.php b/src/Adapter/AdapterInterface.php
@@ -21,7 +21,7 @@ interface AdapterInterface
      * Initialize authentication layer and see if we have a user who's already logged in.
      *
      * @param  ServerRequestInterface $request
-     * @return array|null             Example:['authenticated_user' => AuthenticatedUserInterface, 'authentication_result' => AuthenticationResultInterface];
+     * @return array|null             Example:['authenticated_user' => AuthenticatedUserInterface, 'authenticated_with' => AuthenticationResultInterface];
      */
     public function initialize(ServerRequestInterface $request);
 
@@ -36,7 +36,7 @@ public function authenticate(AuthenticatedUserInterface $authenticated_user);
     /**
      * Terminate an instance that was used to authenticate a user.
      *
-     * @param AuthenticationResultInterface $authentication_result
+     * @param AuthenticationResultInterface $authenticated_with
      */
-    public function terminate(AuthenticationResultInterface $authentication_result);
+    public function terminate(AuthenticationResultInterface $authenticated_with);
 }
diff --git a/src/Adapter/BrowserSession.php b/src/Adapter/BrowserSession.php
@@ -78,7 +78,7 @@ public function initialize(ServerRequestInterface $request)
             if ($user = $session->getAuthenticatedUser($this->user_repository)) {
                 $this->session_repository->recordUsageBySession($session);
 
-                return ['authenticated_user' => $user, 'authentication_result' => $session];
+                return ['authenticated_user' => $user, 'authenticated_with' => $session];
             }
         }
 
@@ -96,10 +96,10 @@ public function authenticate(AuthenticatedUserInterface $authenticated_user)
     /**
      * {@inheritdoc}
      */
-    public function terminate(AuthenticationResultInterface $authentication_result)
+    public function terminate(AuthenticationResultInterface $authenticated_with)
     {
-        if ($authentication_result instanceof SessionInterface) {
-            $this->session_repository->terminateSession($authentication_result);
+        if ($authenticated_with instanceof SessionInterface) {
+            $this->session_repository->terminateSession($authenticated_with);
         } else {
             throw new InvalidArgumentException('Instance is not a browser session');
         }
diff --git a/src/Adapter/TokenBearer.php b/src/Adapter/TokenBearer.php
@@ -63,7 +63,7 @@ public function initialize(ServerRequestInterface $request)
             if ($user = $token->getAuthenticatedUser($this->user_repository)) {
                 $this->token_repository->recordUsageByToken($token);
 
-                return ['authenticated_user' => $user, 'authentication_result' => $token];
+                return ['authenticated_user' => $user, 'authenticated_with' => $token];
             }
         }
 
@@ -81,10 +81,10 @@ public function authenticate(AuthenticatedUserInterface $authenticated_user)
     /**
      * {@inheritdoc}
      */
-    public function terminate(AuthenticationResultInterface $authentication_result)
+    public function terminate(AuthenticationResultInterface $authenticated_with)
     {
-        if ($authentication_result instanceof TokenInterface) {
-            $this->token_repository->terminateToken($authentication_result);
+        if ($authenticated_with instanceof TokenInterface) {
+            $this->token_repository->terminateToken($authenticated_with);
         } else {
             throw new InvalidArgumentException('Instance is not a token');
         }
diff --git a/src/Authentication.php b/src/Authentication.php
@@ -42,14 +42,14 @@ public function __construct(array $adapters)
     public function initialize(RequestInterface $request)
     {
         $exception = null;
-        $results = ['authenticated_user' => [], 'authentication_result' => []];
+        $results = ['authenticated_user' => [], 'authenticated_with' => []];
 
         foreach ($this->adapters as $adapter) {
             try {
                 $result = $adapter->initialize($request);
                 if ($result) {
                     $results['authenticated_user'][] = $result['authenticated_user'];
-                    $results['authentication_result'][] = $result['authentication_result'];
+                    $results['authenticated_with'][] = $result['authenticated_with'];
                 }
             } catch (Exception $e) {
                 $exception = $e;
@@ -70,7 +70,7 @@ public function initialize(RequestInterface $request)
 
         return $request
             ->withAttribute('authenticated_user', $results['authenticated_user'][0])
-            ->withAttribute('authentication_result', $results['authentication_result'][0]);
+            ->withAttribute('authenticated_with', $results['authenticated_with'][0]);
     }
 
     /**
diff --git a/test/src/AuthenticationTest.php b/test/src/AuthenticationTest.php
@@ -114,8 +114,8 @@ public function testUserIsAuthorized()
 
         $authentication = new Authentication([$token_bearer]);
         $request = $authentication->initialize($this->request);
-        $authentication_result = $authentication->authorize($this->authorizer, $token_bearer, ['username' => 'john@doe.com']);
+        $authenticated_with = $authentication->authorize($this->authorizer, $token_bearer, ['username' => 'john@doe.com']);
 
-        $this->assertInstanceOf(AuthenticationResultInterface::class, $authentication_result);
+        $this->assertInstanceOf(AuthenticationResultInterface::class, $authenticated_with);
     }
 }
diff --git a/test/src/BrowserSessionInitializeTest.php b/test/src/BrowserSessionInitializeTest.php
@@ -62,7 +62,7 @@ public function testAuthenticationWithGoodSessionId()
         $results = (new BrowserSession($user_repository, $session_repository, $this->cookies))->initialize($this->request);
 
         $this->assertInstanceOf(AuthenticatedUser::class, $results['authenticated_user']);
-        $this->assertInstanceOf(Session::class, $results['authentication_result']);
+        $this->assertInstanceOf(Session::class, $results['authenticated_with']);
     }
 
     /**
@@ -82,7 +82,7 @@ public function testAuthenticationRecordsSessionUsage()
         $results = (new BrowserSession($user_repository, $session_repository, $this->cookies))->initialize($this->request);
 
         $this->assertInstanceOf(AuthenticatedUser::class, $results['authenticated_user']);
-        $this->assertInstanceOf(Session::class, $results['authentication_result']);
+        $this->assertInstanceOf(Session::class, $results['authenticated_with']);
 
         $this->assertSame(1, $session_repository->getUsageById($test_session_id));
     }
diff --git a/test/src/TokenBearerInitializeTest.php b/test/src/TokenBearerInitializeTest.php
@@ -65,7 +65,7 @@ public function testAuthenticationWithGoodToken()
         $results = (new TokenBearer($user_repository, $token_repository))->initialize($this->request->withHeader('Authorization', "Bearer {$test_token}"));
 
         $this->assertInstanceOf(AuthenticatedUser::class, $results['authenticated_user']);
-        $this->assertInstanceOf(Token::class, $results['authentication_result']);
+        $this->assertInstanceOf(Token::class, $results['authenticated_with']);
     }
 
     /**
@@ -83,7 +83,7 @@ public function testAuthenticationRecordsTokenUsage()
         $results = (new TokenBearer($user_repository, $token_repository))->initialize($this->request->withHeader('Authorization', "Bearer {$test_token}"));
 
         $this->assertInstanceOf(AuthenticatedUser::class, $results['authenticated_user']);
-        $this->assertInstanceOf(Token::class, $results['authentication_result']);
+        $this->assertInstanceOf(Token::class, $results['authenticated_with']);
 
         $this->assertSame(1, $token_repository->getUsageById($test_token));
     }

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ interface AdapterInterface`
`21`	`21`	`* Initialize authentication layer and see if we have a user who's already logged in.`
`22`	`22`	`*`
`23`	`23`	`* @param ServerRequestInterface $request`
`24`		`- * @return array\|null Example:['authenticated_user' => AuthenticatedUserInterface, 'authentication_result' => AuthenticationResultInterface];`
	`24`	`+ * @return array\|null Example:['authenticated_user' => AuthenticatedUserInterface, 'authenticated_with' => AuthenticationResultInterface];`
`25`	`25`	`*/`
`26`	`26`	`public function initialize(ServerRequestInterface $request);`
`27`	`27`
`@@ -36,7 +36,7 @@ public function authenticate(AuthenticatedUserInterface $authenticated_user);`
`36`	`36`	`/**`
`37`	`37`	`* Terminate an instance that was used to authenticate a user.`
`38`	`38`	`*`
`39`		`- * @param AuthenticationResultInterface $authentication_result`
	`39`	`+ * @param AuthenticationResultInterface $authenticated_with`
`40`	`40`	`*/`
`41`		`- public function terminate(AuthenticationResultInterface $authentication_result);`
	`41`	`+ public function terminate(AuthenticationResultInterface $authenticated_with);`
`42`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ public function initialize(ServerRequestInterface $request)`
`78`	`78`	`if ($user = $session->getAuthenticatedUser($this->user_repository)) {`
`79`	`79`	`$this->session_repository->recordUsageBySession($session);`
`80`	`80`
`81`		`- return ['authenticated_user' => $user, 'authentication_result' => $session];`
	`81`	`+ return ['authenticated_user' => $user, 'authenticated_with' => $session];`
`82`	`82`	`}`
`83`	`83`	`}`
`84`	`84`
`@@ -96,10 +96,10 @@ public function authenticate(AuthenticatedUserInterface $authenticated_user)`
`96`	`96`	`/**`
`97`	`97`	`* {@inheritdoc}`
`98`	`98`	`*/`
`99`		`- public function terminate(AuthenticationResultInterface $authentication_result)`
	`99`	`+ public function terminate(AuthenticationResultInterface $authenticated_with)`
`100`	`100`	`{`
`101`		`- if ($authentication_result instanceof SessionInterface) {`
`102`		`- $this->session_repository->terminateSession($authentication_result);`
	`101`	`+ if ($authenticated_with instanceof SessionInterface) {`
	`102`	`+ $this->session_repository->terminateSession($authenticated_with);`
`103`	`103`	`} else {`
`104`	`104`	`throw new InvalidArgumentException('Instance is not a browser session');`
`105`	`105`	`}`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ public function initialize(ServerRequestInterface $request)`
`63`	`63`	`if ($user = $token->getAuthenticatedUser($this->user_repository)) {`
`64`	`64`	`$this->token_repository->recordUsageByToken($token);`
`65`	`65`
`66`		`- return ['authenticated_user' => $user, 'authentication_result' => $token];`
	`66`	`+ return ['authenticated_user' => $user, 'authenticated_with' => $token];`
`67`	`67`	`}`
`68`	`68`	`}`
`69`	`69`
`@@ -81,10 +81,10 @@ public function authenticate(AuthenticatedUserInterface $authenticated_user)`
`81`	`81`	`/**`
`82`	`82`	`* {@inheritdoc}`
`83`	`83`	`*/`
`84`		`- public function terminate(AuthenticationResultInterface $authentication_result)`
	`84`	`+ public function terminate(AuthenticationResultInterface $authenticated_with)`
`85`	`85`	`{`
`86`		`- if ($authentication_result instanceof TokenInterface) {`
`87`		`- $this->token_repository->terminateToken($authentication_result);`
	`86`	`+ if ($authenticated_with instanceof TokenInterface) {`
	`87`	`+ $this->token_repository->terminateToken($authenticated_with);`
`88`	`88`	`} else {`
`89`	`89`	`throw new InvalidArgumentException('Instance is not a token');`
`90`	`90`	`}`
Original file line number	Diff line number	Diff line change
`@@ -114,8 +114,8 @@ public function testUserIsAuthorized()`
`114`	`114`
`115`	`115`	`$authentication = new Authentication([$token_bearer]);`
`116`	`116`	`$request = $authentication->initialize($this->request);`
`117`		`- $authentication_result = $authentication->authorize($this->authorizer, $token_bearer, ['username' => '[email protected]']);`
	`117`	`+ $authenticated_with = $authentication->authorize($this->authorizer, $token_bearer, ['username' => '[email protected]']);`
`118`	`118`
`119`		`- $this->assertInstanceOf(AuthenticationResultInterface::class, $authentication_result);`
	`119`	`+ $this->assertInstanceOf(AuthenticationResultInterface::class, $authenticated_with);`
`120`	`120`	`}`
`121`	`121`	`}`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ public function testAuthenticationWithGoodSessionId()`
`62`	`62`	`$results = (new BrowserSession($user_repository, $session_repository, $this->cookies))->initialize($this->request);`
`63`	`63`
`64`	`64`	`$this->assertInstanceOf(AuthenticatedUser::class, $results['authenticated_user']);`
`65`		`- $this->assertInstanceOf(Session::class, $results['authentication_result']);`
	`65`	`+ $this->assertInstanceOf(Session::class, $results['authenticated_with']);`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`/**`
`@@ -82,7 +82,7 @@ public function testAuthenticationRecordsSessionUsage()`
`82`	`82`	`$results = (new BrowserSession($user_repository, $session_repository, $this->cookies))->initialize($this->request);`
`83`	`83`
`84`	`84`	`$this->assertInstanceOf(AuthenticatedUser::class, $results['authenticated_user']);`
`85`		`- $this->assertInstanceOf(Session::class, $results['authentication_result']);`
	`85`	`+ $this->assertInstanceOf(Session::class, $results['authenticated_with']);`
`86`	`86`
`87`	`87`	`$this->assertSame(1, $session_repository->getUsageById($test_session_id));`
`88`	`88`	`}`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ public function testAuthenticationWithGoodToken()`
`65`	`65`	`$results = (new TokenBearer($user_repository, $token_repository))->initialize($this->request->withHeader('Authorization', "Bearer {$test_token}"));`
`66`	`66`
`67`	`67`	`$this->assertInstanceOf(AuthenticatedUser::class, $results['authenticated_user']);`
`68`		`- $this->assertInstanceOf(Token::class, $results['authentication_result']);`
	`68`	`+ $this->assertInstanceOf(Token::class, $results['authenticated_with']);`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`/**`
`@@ -83,7 +83,7 @@ public function testAuthenticationRecordsTokenUsage()`
`83`	`83`	`$results = (new TokenBearer($user_repository, $token_repository))->initialize($this->request->withHeader('Authorization', "Bearer {$test_token}"));`
`84`	`84`
`85`	`85`	`$this->assertInstanceOf(AuthenticatedUser::class, $results['authenticated_user']);`
`86`		`- $this->assertInstanceOf(Token::class, $results['authentication_result']);`
	`86`	`+ $this->assertInstanceOf(Token::class, $results['authenticated_with']);`
`87`	`87`
`88`	`88`	`$this->assertSame(1, $token_repository->getUsageById($test_token));`
`89`	`89`	`}`