asadku34 / oauth2-zoho

src/Provider/Zoho.php

<?php

namespace Asad\OAuth2\Client\Provider;

use League\OAuth2\Client\Provider\AbstractProvider;
use League\OAuth2\Client\Grant\AbstractGrant;
use Psr\Http\Message\ResponseInterface;
use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
use League\OAuth2\Client\Tool\BearerAuthorizationTrait;
use League\OAuth2\Client\Token\AccessToken;
use Asad\OAuth2\Client\AccessToken\ZohoAccessToken;

class Zoho extends AbstractProvider
{
    use BearerAuthorizationTrait;

    /**
     * You must use your domain-specific Zoho Accounts URL to generate access and refresh tokens.
     * The following are the various domains and their corresponding accounts URLs.
     */

    private $dcDomain = [
        'US' => 'https://accounts.zoho.com',
        'AU' => 'https://accounts.zoho.com.au',
        'EU' => 'https://accounts.zoho.eu',
        'IN' => 'https://accounts.zoho.in',
        'CN' => 'https://accounts.zoho.com.cn',
    ];

    /**
     * @var string define which data center you want to use
     * @link https://www.zoho.com/crm/developer/docs/api/multi-dc.html
     */
    protected $dc;

    /**
     * Get authorization url to begin OAuth flow
     *
     * @return string
     */
    public function getBaseAuthorizationUrl()
    {
        $dc = $this->dc && $this->dc == 'CN' ? $this->dc : 'US';
        return $this->getDcDomain($dc) . '/oauth/v2/auth';
    }

    /**
     * Get access token url to retrieve token
     *
     * @param array $params
     *
     * @return string
     */
    public function getBaseAccessTokenUrl(array $params)
    {
        return $this->getDcDomain($this->dc) . '/oauth/v2/token';
    }

    /**
     * Get provider url to fetch user details
     *
     * @param AccessToken $token
     *
     * @return string
     */
    public function getResourceOwnerDetailsUrl(AccessToken $token)
    {
        return 'https://accounts.zoho.com/oauth/user/info';
    }

    /**
     * @var array List of scopes that will be used for authentication.
     * @link https://www.zoho.com/crm/developer/docs/api/oauth-overview.html#scopes
     * The provided scope will be used if you don't give any scope
     * and this scope will be used to grab user accounts public information
     *
     * @return array
     */
    protected function getDefaultScopes()
    {
        return ['aaaserver.profile.READ'];
    }

    /**
     * Returns the string that should be used to separate scopes when building
     * the URL for requesting an access token.
     *
     * @return string Scope separator, defaults to ','
     */
    protected function getScopeSeparator()
    {
        return ',';
    }

    /**
     * Check a provider response for errors.
     *
     * @param  ResponseInterface $response
     * @param  array|string $data
     *
     * @throws IdentityProviderException
     */
    protected function checkResponse(ResponseInterface $response, $data)
    {
        // @codeCoverageIgnoreStart
        if (empty($data['error'])) {
            return;
        }
        // @codeCoverageIgnoreEnd

        $error = isset($data['error']) ? $data['error'] : null;
        throw new IdentityProviderException(
            $error,
            $response->getStatusCode(),
            $response

$response is of type object<Psr\Http\Message\ResponseInterface>, but the function expects a array|string.

        );
    }

    /**
     * Generate a user object from a successful user details request.
     *
     * @param array $response
     * @param AccessToken $token
     *
     * @return League\OAuth2\Client\Provider\ResourceOwnerInterface
     */
    protected function createResourceOwner(array $response, AccessToken $token)
    {
        return new ZohoUser($response);
    }

    /**
     * Creates an access token from a response.
     *
     * The grant that was used to fetch the response can be used to provide
     * additional context.
     *
     * @param  array $response
     * @param  AbstractGrant $grant
     * @return AccessTokenInterface
     */
    protected function createAccessToken(array $response, AbstractGrant $grant)
    {
        return new ZohoAccessToken($response);
    }

    /**
     * You must use your domain-specific Zoho Accounts URL to generate access and refresh tokens
     * @return string zoho data center url
     */

    private function getDcDomain($dc)
    {
        return $dc && isset($this->dcDomain[$dc]) ? $this->dcDomain[$dc] : $this->fallbackDc();
    }

    /**
     * The zoho default data center
     * @return string zoho default data center url
     */
    private function fallbackDc()
    {
        return $this->dcDomain['US'];
    }
}