Revert to using AccessToken instead of AccessTokenInterface

Fixes #752.

Author: ramsey

src/Provider/AbstractProvider.php

@@ -286,10 +286,10 @@ abstract public function getBaseAccessTokenUrl(array $params);
     /**
      * Returns the URL for requesting the resource owner's details.
      *
-     * @param AccessTokenInterface $token
+     * @param AccessToken $token
      * @return string
      */
-    abstract public function getResourceOwnerDetailsUrl(AccessTokenInterface $token);
+    abstract public function getResourceOwnerDetailsUrl(AccessToken $token);
 
     /**
      * Returns a new random string to use as the state parameter in an
@@ -751,18 +751,18 @@ protected function createAccessToken(array $response, AbstractGrant $grant)
      * details request.
      *
      * @param  array $response
-     * @param  AccessTokenInterface $token
+     * @param  AccessToken $token
      * @return ResourceOwnerInterface
      */
-    abstract protected function createResourceOwner(array $response, AccessTokenInterface $token);
+    abstract protected function createResourceOwner(array $response, AccessToken $token);
 
     /**
      * Requests and returns the resource owner of given access token.
      *
      * @param  AccessTokenInterface $token
      * @return ResourceOwnerInterface
      */
-    public function getResourceOwner(AccessTokenInterface $token)
+    public function getResourceOwner(AccessToken $token)
     {
         $response = $this->fetchResourceOwnerDetails($token);
 
@@ -772,10 +772,10 @@ public function getResourceOwner(AccessTokenInterface $token)
     /**
      * Requests resource owner details.
      *
-     * @param  AccessTokenInterface $token
+     * @param  AccessToken $token
      * @return mixed
      */
-    protected function fetchResourceOwnerDetails(AccessTokenInterface $token)
+    protected function fetchResourceOwnerDetails(AccessToken $token)
     {
         $url = $this->getResourceOwnerDetailsUrl($token);
 

src/Provider/GenericProvider.php

@@ -16,7 +16,7 @@
 
 use InvalidArgumentException;
 use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
-use League\OAuth2\Client\Token\AccessTokenInterface;
+use League\OAuth2\Client\Token\AccessToken;
 use League\OAuth2\Client\Tool\BearerAuthorizationTrait;
 use Psr\Http\Message\ResponseInterface;
 
@@ -168,7 +168,7 @@ public function getBaseAccessTokenUrl(array $params)
     /**
      * @inheritdoc
      */
-    public function getResourceOwnerDetailsUrl(AccessTokenInterface $token)
+    public function getResourceOwnerDetailsUrl(AccessToken $token)
     {
         return $this->urlResourceOwnerDetails;
     }
@@ -226,7 +226,7 @@ protected function checkResponse(ResponseInterface $response, $data)
     /**
      * @inheritdoc
      */
-    protected function createResourceOwner(array $response, AccessTokenInterface $token)
+    protected function createResourceOwner(array $response, AccessToken $token)
     {
         return new GenericResourceOwner($response, $this->responseResourceOwnerId);
     }

src/Tool/BearerAuthorizationTrait.php

@@ -14,6 +14,8 @@
 
 namespace League\OAuth2\Client\Tool;
 
+use League\OAuth2\Client\Token\AccessTokenInterface;
+
 /**
  * Enables `Bearer` header authorization for providers.
  *
@@ -24,7 +26,7 @@ trait BearerAuthorizationTrait
     /**
      * Returns authorization headers for the 'bearer' grant.
      *
-     * @param  mixed|null $token Either a string or an access token instance
+     * @param  AccessTokenInterface|string|null $token Either a string or an access token instance
      * @return array
      */
     protected function getAuthorizationHeaders($token = null)

src/Tool/MacAuthorizationTrait.php

@@ -14,6 +14,7 @@
 
 namespace League\OAuth2\Client\Tool;
 
+use League\OAuth2\Client\Token\AccessToken;
 use League\OAuth2\Client\Token\AccessTokenInterface;
 
 /**
@@ -26,10 +27,10 @@ trait MacAuthorizationTrait
     /**
      * Returns the id of this token for MAC generation.
      *
-     * @param  AccessTokenInterface $token
+     * @param  AccessToken $token
      * @return string
      */
-    abstract protected function getTokenId(AccessTokenInterface $token);
+    abstract protected function getTokenId(AccessToken $token);
 
     /**
      * Returns the MAC signature for the current request.
@@ -53,16 +54,20 @@ abstract protected function getRandomState($length);
     /**
      * Returns the authorization headers for the 'mac' grant.
      *
-     * @param  AccessTokenInterface $token
+     * @param  AccessTokenInterface|string|null $token Either a string or an access token instance
      * @return array
      * @codeCoverageIgnore
      *
      * @todo This is currently untested and provided only as an example. If you
      * complete the implementation, please create a pull request for
      * https://github.com/thephpleague/oauth2-client
      */
-    protected function getAuthorizationHeaders($token)
+    protected function getAuthorizationHeaders($token = null)
     {
+        if ($token === null) {
+            return [];
+        }
+
         $ts    = time();
         $id    = $this->getTokenId($token);
         $nonce = $this->getRandomState(16);

test/src/Provider/AbstractProviderTest.php

@@ -747,4 +747,36 @@ public function testDefaultAuthorizationHeaders()
 
         $this->assertEquals([], $headers);
     }
+
+    /**
+     * This test helps show the fatal errors occurring as a result of incompatible
+     * method signatures after the 2.4.0 release.
+     *
+     * @link https://github.com/thephpleague/oauth2-client/issues/752
+     */
+    public function testExtendedProviderDoesNotErrorWhenUsingAccessTokenAsTheTypeHint()
+    {
+        $token = new AccessToken([
+            'access_token' => 'mock_access_token',
+            'refresh_token' => 'mock_refresh_token',
+            'expires' => time(),
+            'resource_owner_id' => 'mock_resource_owner_id',
+        ]);
+
+        $provider = new Fake\ProviderWithAccessTokenHints([
+            'urlAuthorize' => 'https://example.com/authorize',
+            'urlAccessToken' => 'https://example.com/accessToken',
+            'urlResourceOwnerDetails' => 'https://api.example.com/owner',
+        ]);
+
+        $reflectedProvider = new \ReflectionObject($provider);
+        $getTokenId = $reflectedProvider->getMethod('getTokenId');
+        $getTokenId->setAccessible(true);
+
+        $url = $provider->getResourceOwnerDetailsUrl($token);
+        $tokenId = $getTokenId->invoke($provider, $token);
+
+        $this->assertSame('https://api.example.com/owner/mock_resource_owner_id', $url);
+        $this->assertSame('fake_token_id', $tokenId);
+    }
 }

test/src/Provider/Fake.php

@@ -2,7 +2,7 @@
 
 namespace League\OAuth2\Client\Test\Provider;
 
-use League\OAuth2\Client\Token\AccessTokenInterface;
+use League\OAuth2\Client\Token\AccessToken;
 use League\OAuth2\Client\Tool\BearerAuthorizationTrait;
 use League\OAuth2\Client\Provider\AbstractProvider;
 use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
@@ -24,7 +24,7 @@ public function getBaseAccessTokenUrl(array $params)
         return 'http://example.com/oauth/token';
     }
 
-    public function getResourceOwnerDetailsUrl(AccessTokenInterface $token)
+    public function getResourceOwnerDetailsUrl(AccessToken $token)
     {
         return 'http://example.com/oauth/user';
     }
@@ -44,7 +44,7 @@ public function getAccessTokenMethod()
         return $this->accessTokenMethod;
     }
 
-    protected function createResourceOwner(array $response, AccessTokenInterface $token)
+    protected function createResourceOwner(array $response, AccessToken $token)
     {
         return new Fake\User($response);
     }

test/src/Provider/Fake/ProviderWithAccessTokenHints.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace League\OAuth2\Client\Test\Provider\Fake;
+
+use League\OAuth2\Client\Provider\GenericProvider;
+use League\OAuth2\Client\Provider\GenericResourceOwner;
+use League\OAuth2\Client\Token\AccessToken;
+use League\OAuth2\Client\Tool\MacAuthorizationTrait;
+
+class ProviderWithAccessTokenHints extends GenericProvider
+{
+    use MacAuthorizationTrait;
+
+    public function getResourceOwnerDetailsUrl(AccessToken $token)
+    {
+        return 'https://api.example.com/owner/' . $token->getResourceOwnerId();
+    }
+
+    protected function createResourceOwner(array $response, AccessToken $token)
+    {
+        return new GenericResourceOwner($response, $token->getResourceOwnerId());
+    }
+
+    public function getResourceOwner(AccessToken $token)
+    {
+        return $this->createResourceOwner([], $token);
+    }
+
+    protected function fetchResourceOwnerDetails(AccessToken $token)
+    {
+        return [];
+    }
+
+    protected function getTokenId(AccessToken $token)
+    {
+        return 'fake_token_id';
+    }
+
+    protected function getMacSignature($id, $ts, $nonce)
+    {
+        return 'fake_mac_signature';
+    }
+}

test/src/Provider/Generic.php

@@ -2,7 +2,7 @@
 
 namespace League\OAuth2\Client\Test\Provider;
 
-use League\OAuth2\Client\Token\AccessTokenInterface;
+use League\OAuth2\Client\Token\AccessToken;
 use League\OAuth2\Client\Provider\GenericProvider;
 
 class Generic extends GenericProvider
@@ -19,7 +19,7 @@ public function __construct($options = [], array $collaborators = [])
         parent::__construct($options);
     }
 
-    protected function fetchResourceOwnerDetails(AccessTokenInterface $token)
+    protected function fetchResourceOwnerDetails(AccessToken $token)
     {
         return [
             'mock_response_uid' => 1,