hybridauth / hybridauth

src/Provider/MicrosoftGraph.php

Indentation +123 added lines, -123 removed lines

@@ -43,127 +43,127 @@
  */
 class MicrosoftGraph extends OAuth2
 {
-    /**
-     * {@inheritdoc}
-     */
-    protected $scope = 'openid user.read contacts.read';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected $apiBaseUrl = 'https://graph.microsoft.com/v1.0/';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected $authorizeUrl = 'https://login.microsoftonline.com/common/oauth2/v2.0/authorize';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected $accessTokenUrl = 'https://login.microsoftonline.com/common/oauth2/v2.0/token';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected $apiDocumentation = 'https://developer.microsoft.com/en-us/graph/docs/concepts/php';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected function initialize()
-    {
-        parent::initialize();
-
-        $tenant = $this->config->get('tenant');
-        if (!empty($tenant)) {
-            $adjustedEndpoints = [
-                'authorize_url' => str_replace('/common/', '/' . $tenant . '/', $this->authorizeUrl),
-                'access_token_url' => str_replace('/common/', '/' . $tenant . '/', $this->accessTokenUrl),
-            ];
-
-            $this->setApiEndpoints($adjustedEndpoints);
-        }
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getUserProfile()
-    {
-        $response = $this->apiRequest('me');
-
-        $data = new Data\Collection($response);
-
-        if (!$data->exists('id')) {
-            throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
-        }
-
-        $userProfile = new User\Profile();
-
-        $userProfile->identifier = $data->get('id');
-        $userProfile->displayName = $data->get('displayName');
-        $userProfile->firstName = $data->get('givenName');
-        $userProfile->lastName = $data->get('surname');
-        $userProfile->language = $data->get('preferredLanguage');
-
-        $userProfile->phone = $data->get('mobilePhone');
-        if (empty($userProfile->phone)) {
-            $businessPhones = $data->get('businessPhones');
-            if (isset($businessPhones[0])) {
-                $userProfile->phone = $businessPhones[0];
-            }
-        }
-
-        $userProfile->email = $data->get('mail');
-        if (empty($userProfile->email)) {
-            $email = $data->get('userPrincipalName');
-            if (strpos($email, '@') !== false) {
-                $userProfile->email = $email;
-            }
-        }
-
-        return $userProfile;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getUserContacts()
-    {
-        $apiUrl = 'me/contacts?$top=50';
-        $contacts = [];
-
-        do {
-            $response = $this->apiRequest($apiUrl);
-            $data = new Data\Collection($response);
-            if (!$data->exists('value')) {
-                throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
-            }
-            foreach ($data->filter('value')->toArray() as $entry) {
-                $entry = new Data\Collection($entry);
-                $userContact = new User\Contact();
-                $userContact->identifier = $entry->get('id');
-                $userContact->displayName = $entry->get('displayName');
-                $emailAddresses = $entry->get('emailAddresses');
-                if (!empty($emailAddresses)) {
-                    $userContact->email = $emailAddresses[0]->address;
-                }
-                // only add to collection if we have usefull data
-                if (!empty($userContact->displayName) || !empty($userContact->email)) {
-                    $contacts[] = $userContact;
-                }
-            }
-
-            if ($data->exists('@odata.nextLink')) {
-                $apiUrl = $data->get('@odata.nextLink');
-
-                $pagedList = true;
-            } else {
-                $pagedList = false;
-            }
-        } while ($pagedList);
-
-        return $contacts;
-    }
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $scope = 'openid user.read contacts.read';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $apiBaseUrl = 'https://graph.microsoft.com/v1.0/';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $authorizeUrl = 'https://login.microsoftonline.com/common/oauth2/v2.0/authorize';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $accessTokenUrl = 'https://login.microsoftonline.com/common/oauth2/v2.0/token';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $apiDocumentation = 'https://developer.microsoft.com/en-us/graph/docs/concepts/php';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function initialize()
+	{
+		parent::initialize();
+
+		$tenant = $this->config->get('tenant');
+		if (!empty($tenant)) {
+			$adjustedEndpoints = [
+				'authorize_url' => str_replace('/common/', '/' . $tenant . '/', $this->authorizeUrl),
+				'access_token_url' => str_replace('/common/', '/' . $tenant . '/', $this->accessTokenUrl),
+			];
+
+			$this->setApiEndpoints($adjustedEndpoints);
+		}
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getUserProfile()
+	{
+		$response = $this->apiRequest('me');
+
+		$data = new Data\Collection($response);
+
+		if (!$data->exists('id')) {
+			throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
+		}
+
+		$userProfile = new User\Profile();
+
+		$userProfile->identifier = $data->get('id');
+		$userProfile->displayName = $data->get('displayName');
+		$userProfile->firstName = $data->get('givenName');
+		$userProfile->lastName = $data->get('surname');
+		$userProfile->language = $data->get('preferredLanguage');
+
+		$userProfile->phone = $data->get('mobilePhone');
+		if (empty($userProfile->phone)) {
+			$businessPhones = $data->get('businessPhones');
+			if (isset($businessPhones[0])) {
+				$userProfile->phone = $businessPhones[0];
+			}
+		}
+
+		$userProfile->email = $data->get('mail');
+		if (empty($userProfile->email)) {
+			$email = $data->get('userPrincipalName');
+			if (strpos($email, '@') !== false) {
+				$userProfile->email = $email;
+			}
+		}
+
+		return $userProfile;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getUserContacts()
+	{
+		$apiUrl = 'me/contacts?$top=50';
+		$contacts = [];
+
+		do {
+			$response = $this->apiRequest($apiUrl);
+			$data = new Data\Collection($response);
+			if (!$data->exists('value')) {
+				throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
+			}
+			foreach ($data->filter('value')->toArray() as $entry) {
+				$entry = new Data\Collection($entry);
+				$userContact = new User\Contact();
+				$userContact->identifier = $entry->get('id');
+				$userContact->displayName = $entry->get('displayName');
+				$emailAddresses = $entry->get('emailAddresses');
+				if (!empty($emailAddresses)) {
+					$userContact->email = $emailAddresses[0]->address;
+				}
+				// only add to collection if we have usefull data
+				if (!empty($userContact->displayName) || !empty($userContact->email)) {
+					$contacts[] = $userContact;
+				}
+			}
+
+			if ($data->exists('@odata.nextLink')) {
+				$apiUrl = $data->get('@odata.nextLink');
+
+				$pagedList = true;
+			} else {
+				$pagedList = false;
+			}
+		} while ($pagedList);
+
+		return $contacts;
+	}
 }

src/Provider/Telegram.php

Indentation +164 added lines, -164 removed lines

@@ -44,143 +44,143 @@ 
  */
 class Telegram extends AbstractAdapter implements AdapterInterface
 {
-    protected $botId = '';
-
-    protected $botSecret = '';
-
-    protected $callbackUrl = '';
-
-    /**
-     * IPD API Documentation
-     *
-     * OPTIONAL.
-     *
-     * @var string
-     */
-    protected $apiDocumentation = 'https://core.telegram.org/bots';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected function configure()
-    {
-        $this->botId = $this->config->filter('keys')->get('id');
-        $this->botSecret = $this->config->filter('keys')->get('secret');
-        $this->callbackUrl = $this->config->get('callback');
-
-        if (!$this->botId || !$this->botSecret) {
-            throw new InvalidApplicationCredentialsException(
-                'Your application id is required in order to connect to ' . $this->providerId
-            );
-        }
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    protected function initialize()
-    {
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function authenticate()
-    {
-        $this->logger->info(sprintf('%s::authenticate()', get_class($this)));
-        if (!filter_input(INPUT_GET, 'hash')) {
-            $this->authenticateBegin();
-        } else {
-            $this->authenticateCheckError();
-            $this->authenticateFinish();
-        }
-        return null;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function isConnected()
-    {
-        $authData = $this->getStoredData('auth_data');
-        return !empty($authData);
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getUserProfile()
-    {
-        $data = new Collection($this->getStoredData('auth_data'));
-
-        if (!$data->exists('id')) {
-            throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
-        }
-
-        $userProfile = new Profile();
-
-        $userProfile->identifier = $data->get('id');
-        $userProfile->firstName = $data->get('first_name');
-        $userProfile->lastName = $data->get('last_name');
-        $userProfile->displayName = $data->get('username');
-        $userProfile->photoURL = $data->get('photo_url');
-        $username = $data->get('username');
-        if (!empty($username)) {
-            // Only some accounts have usernames.
-            $userProfile->profileURL = "https://t.me/{$username}";
-        }
-
-        return $userProfile;
-    }
-
-    /**
-     * See: https://telegram.im/widget-login.php
-     * See: https://gist.github.com/anonymous/6516521b1fb3b464534fbc30ea3573c2
-     */
-    protected function authenticateCheckError()
-    {
-        $auth_data = $this->parseAuthData();
-
-        $check_hash = $auth_data['hash'];
-        unset($auth_data['hash']);
-        $data_check_arr = [];
-
-        foreach ($auth_data as $key => $value) {
-            if (!empty($value)) {
-                $data_check_arr[] = $key . '=' . $value;
-            }
-        }
-        sort($data_check_arr);
-
-        $data_check_string = implode("\n", $data_check_arr);
-        $secret_key = hash('sha256', $this->botSecret, true);
-        $hash = hash_hmac('sha256', $data_check_string, $secret_key);
-
-        if (strcmp($hash, $check_hash) !== 0) {
-            throw new InvalidAuthorizationCodeException(
-                sprintf('Provider returned an error: %s', 'Data is NOT from Telegram')
-            );
-        }
-
-        if ((time() - $auth_data['auth_date']) > 86400) {
-            throw new InvalidAuthorizationCodeException(
-                sprintf('Provider returned an error: %s', 'Data is outdated')
-            );
-        }
-    }
-
-    /**
-     * See: https://telegram.im/widget-login.php
-     */
-    protected function authenticateBegin()
-    {
-        $this->logger->debug(sprintf('%s::authenticateBegin(), redirecting user to:', get_class($this)));
-
-        $nonce = $this->config->get('nonce');
-        $nonce_code = empty($nonce) ? '' : "nonce=\"{$nonce}\"";
-
-        exit(
-            <<<HTML
+	protected $botId = '';
+
+	protected $botSecret = '';
+
+	protected $callbackUrl = '';
+
+	/**
+	 * IPD API Documentation
+	 *
+	 * OPTIONAL.
+	 *
+	 * @var string
+	 */
+	protected $apiDocumentation = 'https://core.telegram.org/bots';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function configure()
+	{
+		$this->botId = $this->config->filter('keys')->get('id');
+		$this->botSecret = $this->config->filter('keys')->get('secret');
+		$this->callbackUrl = $this->config->get('callback');
+
+		if (!$this->botId || !$this->botSecret) {
+			throw new InvalidApplicationCredentialsException(
+				'Your application id is required in order to connect to ' . $this->providerId
+			);
+		}
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function initialize()
+	{
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function authenticate()
+	{
+		$this->logger->info(sprintf('%s::authenticate()', get_class($this)));
+		if (!filter_input(INPUT_GET, 'hash')) {
+			$this->authenticateBegin();
+		} else {
+			$this->authenticateCheckError();
+			$this->authenticateFinish();
+		}
+		return null;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function isConnected()
+	{
+		$authData = $this->getStoredData('auth_data');
+		return !empty($authData);
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getUserProfile()
+	{
+		$data = new Collection($this->getStoredData('auth_data'));
+
+		if (!$data->exists('id')) {
+			throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
+		}
+
+		$userProfile = new Profile();
+
+		$userProfile->identifier = $data->get('id');
+		$userProfile->firstName = $data->get('first_name');
+		$userProfile->lastName = $data->get('last_name');
+		$userProfile->displayName = $data->get('username');
+		$userProfile->photoURL = $data->get('photo_url');
+		$username = $data->get('username');
+		if (!empty($username)) {
+			// Only some accounts have usernames.
+			$userProfile->profileURL = "https://t.me/{$username}";
+		}
+
+		return $userProfile;
+	}
+
+	/**
+	 * See: https://telegram.im/widget-login.php
+	 * See: https://gist.github.com/anonymous/6516521b1fb3b464534fbc30ea3573c2
+	 */
+	protected function authenticateCheckError()
+	{
+		$auth_data = $this->parseAuthData();
+
+		$check_hash = $auth_data['hash'];
+		unset($auth_data['hash']);
+		$data_check_arr = [];
+
+		foreach ($auth_data as $key => $value) {
+			if (!empty($value)) {
+				$data_check_arr[] = $key . '=' . $value;
+			}
+		}
+		sort($data_check_arr);
+
+		$data_check_string = implode("\n", $data_check_arr);
+		$secret_key = hash('sha256', $this->botSecret, true);
+		$hash = hash_hmac('sha256', $data_check_string, $secret_key);
+
+		if (strcmp($hash, $check_hash) !== 0) {
+			throw new InvalidAuthorizationCodeException(
+				sprintf('Provider returned an error: %s', 'Data is NOT from Telegram')
+			);
+		}
+
+		if ((time() - $auth_data['auth_date']) > 86400) {
+			throw new InvalidAuthorizationCodeException(
+				sprintf('Provider returned an error: %s', 'Data is outdated')
+			);
+		}
+	}
+
+	/**
+	 * See: https://telegram.im/widget-login.php
+	 */
+	protected function authenticateBegin()
+	{
+		$this->logger->debug(sprintf('%s::authenticateBegin(), redirecting user to:', get_class($this)));
+
+		$nonce = $this->config->get('nonce');
+		$nonce_code = empty($nonce) ? '' : "nonce=\"{$nonce}\"";
+
+		exit(
+			<<<HTML
 <center>
     <script async src="https://telegram.org/js/telegram-widget.js?7"
             {$nonce_code}
@@ -191,31 +191,31 @@ 
     </script>
 </center>
 HTML
-        );
-    }
-
-    protected function authenticateFinish()
-    {
-        $this->logger->debug(
-            sprintf('%s::authenticateFinish(), callback url:', get_class($this)),
-            [Util::getCurrentUrl(true)]
-        );
-
-        $this->storeData('auth_data', $this->parseAuthData());
-
-        $this->initialize();
-    }
-
-    protected function parseAuthData()
-    {
-        return [
-            'id' => filter_input(INPUT_GET, 'id'),
-            'first_name' => filter_input(INPUT_GET, 'first_name'),
-            'last_name' => filter_input(INPUT_GET, 'last_name'),
-            'username' => filter_input(INPUT_GET, 'username'),
-            'photo_url' => filter_input(INPUT_GET, 'photo_url'),
-            'auth_date' => filter_input(INPUT_GET, 'auth_date'),
-            'hash' => filter_input(INPUT_GET, 'hash'),
-        ];
-    }
+		);
+	}
+
+	protected function authenticateFinish()
+	{
+		$this->logger->debug(
+			sprintf('%s::authenticateFinish(), callback url:', get_class($this)),
+			[Util::getCurrentUrl(true)]
+		);
+
+		$this->storeData('auth_data', $this->parseAuthData());
+
+		$this->initialize();
+	}
+
+	protected function parseAuthData()
+	{
+		return [
+			'id' => filter_input(INPUT_GET, 'id'),
+			'first_name' => filter_input(INPUT_GET, 'first_name'),
+			'last_name' => filter_input(INPUT_GET, 'last_name'),
+			'username' => filter_input(INPUT_GET, 'username'),
+			'photo_url' => filter_input(INPUT_GET, 'photo_url'),
+			'auth_date' => filter_input(INPUT_GET, 'auth_date'),
+			'hash' => filter_input(INPUT_GET, 'hash'),
+		];
+	}
 }

src/HttpClient/Curl.php

Indentation +301 added lines, -301 removed lines

@@ -12,305 +12,305 @@
  */
 class Curl implements HttpClientInterface
 {
-    /**
-     * Default curl options
-     *
-     * These defaults options can be overwritten when sending requests.
-     *
-     * See setCurlOptions()
-     *
-     * @var array
-     */
-    protected $curlOptions = [
-        CURLOPT_TIMEOUT => 30,
-        CURLOPT_CONNECTTIMEOUT => 30,
-        CURLOPT_SSL_VERIFYPEER => false,
-        CURLOPT_SSL_VERIFYHOST => false,
-        CURLOPT_RETURNTRANSFER => true,
-        CURLOPT_FOLLOWLOCATION => true,
-        CURLOPT_MAXREDIRS => 5,
-        CURLINFO_HEADER_OUT => true,
-        CURLOPT_ENCODING => 'identity',
-        // phpcs:ignore
-        CURLOPT_USERAGENT => 'Hybridauth, PHP Social Authentication Library (https://github.com/hybridauth/hybridauth)',
-    ];
-
-    /**
-     * Method request() arguments
-     *
-     * This is used for debugging.
-     *
-     * @var array
-     */
-    protected $requestArguments = [];
-
-    /**
-     * Default request headers
-     *
-     * @var array
-     */
-    protected $requestHeader = [
-        'Accept' => '*/*',
-        'Cache-Control' => 'max-age=0',
-        'Connection' => 'keep-alive',
-        'Expect' => '',
-        'Pragma' => '',
-    ];
-
-    /**
-     * Raw response returned by server
-     *
-     * @var string
-     */
-    protected $responseBody = '';
-
-    /**
-     * Headers returned in the response
-     *
-     * @var array
-     */
-    protected $responseHeader = [];
-
-    /**
-     * Response HTTP status code
-     *
-     * @var int
-     */
-    protected $responseHttpCode = 0;
-
-    /**
-     * Last curl error number
-     *
-     * @var mixed
-     */
-    protected $responseClientError = null;
-
-    /**
-     * Information about the last transfer
-     *
-     * @var mixed
-     */
-    protected $responseClientInfo = [];
-
-    /**
-     * Hybridauth logger instance
-     *
-     * @var object
-     */
-    protected $logger = null;
-
-    /**
-     * {@inheritdoc}
-     */
-    public function request($uri, $method = 'GET', $parameters = [], $headers = [], $multipart = false)
-    {
-        $this->requestHeader = array_replace($this->requestHeader, (array)$headers);
-
-        $this->requestArguments = [
-            'uri' => $uri,
-            'method' => $method,
-            'parameters' => $parameters,
-            'headers' => $this->requestHeader,
-        ];
-
-        $curl = curl_init();
-
-        switch ($method) {
-            case 'GET':
-            case 'DELETE':
-                unset($this->curlOptions[CURLOPT_POST]);
-                unset($this->curlOptions[CURLOPT_POSTFIELDS]);
-
-                $uri = $uri . (strpos($uri, '?') ? '&' : '?') . http_build_query($parameters);
-                if ($method === 'DELETE') {
-                    $this->curlOptions[CURLOPT_CUSTOMREQUEST] = 'DELETE';
-                }
-                break;
-            case 'PUT':
-            case 'POST':
-            case 'PATCH':
-                $body_content = $multipart ? $parameters : http_build_query($parameters);
-                if (isset($this->requestHeader['Content-Type'])
-                    && $this->requestHeader['Content-Type'] == 'application/json'
-                ) {
-                    $body_content = json_encode($parameters);
-                }
-
-                if ($method === 'POST') {
-                    $this->curlOptions[CURLOPT_POST] = true;
-                } else {
-                    $this->curlOptions[CURLOPT_CUSTOMREQUEST] = $method;
-                }
-                $this->curlOptions[CURLOPT_POSTFIELDS] = $body_content;
-                break;
-        }
-
-        $this->curlOptions[CURLOPT_URL] = $uri;
-        $this->curlOptions[CURLOPT_HTTPHEADER] = $this->prepareRequestHeaders();
-        $this->curlOptions[CURLOPT_HEADERFUNCTION] = [$this, 'fetchResponseHeader'];
-
-        foreach ($this->curlOptions as $opt => $value) {
-            curl_setopt($curl, $opt, $value);
-        }
-
-        $response = curl_exec($curl);
-
-        $this->responseBody = $response;
-        $this->responseHttpCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
-        $this->responseClientError = curl_error($curl);
-        $this->responseClientInfo = curl_getinfo($curl);
-
-        if ($this->logger) {
-            // phpcs:ignore
-            $this->logger->debug(sprintf('%s::request( %s, %s ), response:', get_class($this), $uri, $method), $this->getResponse());
-
-            if (false === $response) {
-                // phpcs:ignore
-                $this->logger->error(sprintf('%s::request( %s, %s ), error:', get_class($this), $uri, $method), [$this->responseClientError]);
-            }
-        }
-
-        curl_close($curl);
-
-        return $this->responseBody;
-    }
-
-    /**
-     * Get response details
-     *
-     * @return array Map structure of details
-     */
-    public function getResponse()
-    {
-        $curlOptions = $this->curlOptions;
-
-        $curlOptions[CURLOPT_HEADERFUNCTION] = '*omitted';
-
-        return [
-            'request' => $this->getRequestArguments(),
-            'response' => [
-                'code' => $this->getResponseHttpCode(),
-                'headers' => $this->getResponseHeader(),
-                'body' => $this->getResponseBody(),
-            ],
-            'client' => [
-                'error' => $this->getResponseClientError(),
-                'info' => $this->getResponseClientInfo(),
-                'opts' => $curlOptions,
-            ],
-        ];
-    }
-
-    /**
-     * Reset curl options
-     *
-     * @param array $curlOptions
-     */
-    public function setCurlOptions($curlOptions)
-    {
-        foreach ($curlOptions as $opt => $value) {
-            $this->curlOptions[$opt] = $value;
-        }
-    }
-
-    /**
-     * Set logger instance
-     *
-     * @param object $logger
-     */
-    public function setLogger($logger)
-    {
-        $this->logger = $logger;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getResponseBody()
-    {
-        return $this->responseBody;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getResponseHeader()
-    {
-        return $this->responseHeader;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getResponseHttpCode()
-    {
-        return $this->responseHttpCode;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getResponseClientError()
-    {
-        return $this->responseClientError;
-    }
-
-    /**
-     * @return array
-     */
-    protected function getResponseClientInfo()
-    {
-        return $this->responseClientInfo;
-    }
-
-    /**
-     * Returns method request() arguments
-     *
-     * This is used for debugging.
-     *
-     * @return array
-     */
-    protected function getRequestArguments()
-    {
-        return $this->requestArguments;
-    }
-
-    /**
-     * Fetch server response headers
-     *
-     * @param mixed $curl
-     * @param string $header
-     *
-     * @return int
-     */
-    protected function fetchResponseHeader($curl, $header)
-    {
-        $pos = strpos($header, ':');
-
-        if (!empty($pos)) {
-            $key = str_replace('-', '_', strtolower(substr($header, 0, $pos)));
-
-            $value = trim(substr($header, $pos + 2));
-
-            $this->responseHeader[$key] = $value;
-        }
-
-        return strlen($header);
-    }
-
-    /**
-     * Convert request headers to the expect curl format
-     *
-     * @return array
-     */
-    protected function prepareRequestHeaders()
-    {
-        $headers = [];
-
-        foreach ($this->requestHeader as $header => $value) {
-            $headers[] = trim($header) . ': ' . trim($value);
-        }
-
-        return $headers;
-    }
+	/**
+	 * Default curl options
+	 *
+	 * These defaults options can be overwritten when sending requests.
+	 *
+	 * See setCurlOptions()
+	 *
+	 * @var array
+	 */
+	protected $curlOptions = [
+		CURLOPT_TIMEOUT => 30,
+		CURLOPT_CONNECTTIMEOUT => 30,
+		CURLOPT_SSL_VERIFYPEER => false,
+		CURLOPT_SSL_VERIFYHOST => false,
+		CURLOPT_RETURNTRANSFER => true,
+		CURLOPT_FOLLOWLOCATION => true,
+		CURLOPT_MAXREDIRS => 5,
+		CURLINFO_HEADER_OUT => true,
+		CURLOPT_ENCODING => 'identity',
+		// phpcs:ignore
+		CURLOPT_USERAGENT => 'Hybridauth, PHP Social Authentication Library (https://github.com/hybridauth/hybridauth)',
+	];
+
+	/**
+	 * Method request() arguments
+	 *
+	 * This is used for debugging.
+	 *
+	 * @var array
+	 */
+	protected $requestArguments = [];
+
+	/**
+	 * Default request headers
+	 *
+	 * @var array
+	 */
+	protected $requestHeader = [
+		'Accept' => '*/*',
+		'Cache-Control' => 'max-age=0',
+		'Connection' => 'keep-alive',
+		'Expect' => '',
+		'Pragma' => '',
+	];
+
+	/**
+	 * Raw response returned by server
+	 *
+	 * @var string
+	 */
+	protected $responseBody = '';
+
+	/**
+	 * Headers returned in the response
+	 *
+	 * @var array
+	 */
+	protected $responseHeader = [];
+
+	/**
+	 * Response HTTP status code
+	 *
+	 * @var int
+	 */
+	protected $responseHttpCode = 0;
+
+	/**
+	 * Last curl error number
+	 *
+	 * @var mixed
+	 */
+	protected $responseClientError = null;
+
+	/**
+	 * Information about the last transfer
+	 *
+	 * @var mixed
+	 */
+	protected $responseClientInfo = [];
+
+	/**
+	 * Hybridauth logger instance
+	 *
+	 * @var object
+	 */
+	protected $logger = null;
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function request($uri, $method = 'GET', $parameters = [], $headers = [], $multipart = false)
+	{
+		$this->requestHeader = array_replace($this->requestHeader, (array)$headers);
+
+		$this->requestArguments = [
+			'uri' => $uri,
+			'method' => $method,
+			'parameters' => $parameters,
+			'headers' => $this->requestHeader,
+		];
+
+		$curl = curl_init();
+
+		switch ($method) {
+			case 'GET':
+			case 'DELETE':
+				unset($this->curlOptions[CURLOPT_POST]);
+				unset($this->curlOptions[CURLOPT_POSTFIELDS]);
+
+				$uri = $uri . (strpos($uri, '?') ? '&' : '?') . http_build_query($parameters);
+				if ($method === 'DELETE') {
+					$this->curlOptions[CURLOPT_CUSTOMREQUEST] = 'DELETE';
+				}
+				break;
+			case 'PUT':
+			case 'POST':
+			case 'PATCH':
+				$body_content = $multipart ? $parameters : http_build_query($parameters);
+				if (isset($this->requestHeader['Content-Type'])
+					&& $this->requestHeader['Content-Type'] == 'application/json'
+				) {
+					$body_content = json_encode($parameters);
+				}
+
+				if ($method === 'POST') {
+					$this->curlOptions[CURLOPT_POST] = true;
+				} else {
+					$this->curlOptions[CURLOPT_CUSTOMREQUEST] = $method;
+				}
+				$this->curlOptions[CURLOPT_POSTFIELDS] = $body_content;
+				break;
+		}
+
+		$this->curlOptions[CURLOPT_URL] = $uri;
+		$this->curlOptions[CURLOPT_HTTPHEADER] = $this->prepareRequestHeaders();
+		$this->curlOptions[CURLOPT_HEADERFUNCTION] = [$this, 'fetchResponseHeader'];
+
+		foreach ($this->curlOptions as $opt => $value) {
+			curl_setopt($curl, $opt, $value);
+		}
+
+		$response = curl_exec($curl);
+
+		$this->responseBody = $response;
+		$this->responseHttpCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
+		$this->responseClientError = curl_error($curl);
+		$this->responseClientInfo = curl_getinfo($curl);
+
+		if ($this->logger) {
+			// phpcs:ignore
+			$this->logger->debug(sprintf('%s::request( %s, %s ), response:', get_class($this), $uri, $method), $this->getResponse());
+
+			if (false === $response) {
+				// phpcs:ignore
+				$this->logger->error(sprintf('%s::request( %s, %s ), error:', get_class($this), $uri, $method), [$this->responseClientError]);
+			}
+		}
+
+		curl_close($curl);
+
+		return $this->responseBody;
+	}
+
+	/**
+	 * Get response details
+	 *
+	 * @return array Map structure of details
+	 */
+	public function getResponse()
+	{
+		$curlOptions = $this->curlOptions;
+
+		$curlOptions[CURLOPT_HEADERFUNCTION] = '*omitted';
+
+		return [
+			'request' => $this->getRequestArguments(),
+			'response' => [
+				'code' => $this->getResponseHttpCode(),
+				'headers' => $this->getResponseHeader(),
+				'body' => $this->getResponseBody(),
+			],
+			'client' => [
+				'error' => $this->getResponseClientError(),
+				'info' => $this->getResponseClientInfo(),
+				'opts' => $curlOptions,
+			],
+		];
+	}
+
+	/**
+	 * Reset curl options
+	 *
+	 * @param array $curlOptions
+	 */
+	public function setCurlOptions($curlOptions)
+	{
+		foreach ($curlOptions as $opt => $value) {
+			$this->curlOptions[$opt] = $value;
+		}
+	}
+
+	/**
+	 * Set logger instance
+	 *
+	 * @param object $logger
+	 */
+	public function setLogger($logger)
+	{
+		$this->logger = $logger;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getResponseBody()
+	{
+		return $this->responseBody;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getResponseHeader()
+	{
+		return $this->responseHeader;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getResponseHttpCode()
+	{
+		return $this->responseHttpCode;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getResponseClientError()
+	{
+		return $this->responseClientError;
+	}
+
+	/**
+	 * @return array
+	 */
+	protected function getResponseClientInfo()
+	{
+		return $this->responseClientInfo;
+	}
+
+	/**
+	 * Returns method request() arguments
+	 *
+	 * This is used for debugging.
+	 *
+	 * @return array
+	 */
+	protected function getRequestArguments()
+	{
+		return $this->requestArguments;
+	}
+
+	/**
+	 * Fetch server response headers
+	 *
+	 * @param mixed $curl
+	 * @param string $header
+	 *
+	 * @return int
+	 */
+	protected function fetchResponseHeader($curl, $header)
+	{
+		$pos = strpos($header, ':');
+
+		if (!empty($pos)) {
+			$key = str_replace('-', '_', strtolower(substr($header, 0, $pos)));
+
+			$value = trim(substr($header, $pos + 2));
+
+			$this->responseHeader[$key] = $value;
+		}
+
+		return strlen($header);
+	}
+
+	/**
+	 * Convert request headers to the expect curl format
+	 *
+	 * @return array
+	 */
+	protected function prepareRequestHeaders()
+	{
+		$headers = [];
+
+		foreach ($this->requestHeader as $header => $value) {
+			$headers[] = trim($header) . ': ' . trim($value);
+		}
+
+		return $headers;
+	}
 }

src/Adapter/OAuth1.php

Indentation +586 added lines, -586 removed lines

@@ -27,590 +27,590 @@
  */
 abstract class OAuth1 extends AbstractAdapter implements AdapterInterface
 {
-    /**
-     * Base URL to provider API
-     *
-     * This var will be used to build urls when sending signed requests
-     *
-     * @var string
-     */
-    protected $apiBaseUrl = '';
-
-    /**
-     * @var string
-     */
-    protected $authorizeUrl = '';
-
-    /**
-     * @var string
-     */
-    protected $requestTokenUrl = '';
-
-    /**
-     * @var string
-     */
-    protected $accessTokenUrl = '';
-
-    /**
-     * IPD API Documentation
-     *
-     * OPTIONAL.
-     *
-     * @var string
-     */
-    protected $apiDocumentation = '';
-
-    /**
-     * OAuth Version
-     *
-     *  '1.0' OAuth Core 1.0
-     * '1.0a' OAuth Core 1.0 Revision A
-     *
-     * @var string
-     */
-    protected $oauth1Version = '1.0a';
-
-    /**
-     * @var string
-     */
-    protected $consumerKey = null;
-
-    /**
-     * @var string
-     */
-    protected $consumerSecret = null;
-
-    /**
-     * @var object
-     */
-    protected $OAuthConsumer = null;
-
-    /**
-     * @var object
-     */
-    protected $sha1Method = null;
-
-    /**
-     * @var object
-     */
-    protected $consumerToken = null;
-
-    /**
-     * Authorization Url Parameters
-     *
-     * @var bool
-     */
-    protected $AuthorizeUrlParameters = [];
-
-    /**
-     * @var string
-     */
-    protected $requestTokenMethod = 'POST';
-
-    /**
-     * @var array
-     */
-    protected $requestTokenParameters = [];
-
-    /**
-     * @var array
-     */
-    protected $requestTokenHeaders = [];
-
-    /**
-     * @var string
-     */
-    protected $tokenExchangeMethod = 'POST';
-
-    /**
-     * @var array
-     */
-    protected $tokenExchangeParameters = [];
-
-    /**
-     * @var array
-     */
-    protected $tokenExchangeHeaders = [];
-
-    /**
-     * @var array
-     */
-    protected $apiRequestParameters = [];
-
-    /**
-     * @var array
-     */
-    protected $apiRequestHeaders = [];
-
-    /**
-     * {@inheritdoc}
-     */
-    protected function configure()
-    {
-        $this->consumerKey = $this->config->filter('keys')->get('id') ?: $this->config->filter('keys')->get('key');
-        $this->consumerSecret = $this->config->filter('keys')->get('secret');
-
-        if (!$this->consumerKey || !$this->consumerSecret) {
-            throw new InvalidApplicationCredentialsException(
-                'Your application id is required in order to connect to ' . $this->providerId
-            );
-        }
-
-        if ($this->config->exists('tokens')) {
-            $this->setAccessToken($this->config->get('tokens'));
-        }
-
-        $this->setCallback($this->config->get('callback'));
-        $this->setApiEndpoints($this->config->get('endpoints'));
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    protected function initialize()
-    {
-        /**
-         * Set up OAuth Signature and Consumer
-         *
-         * OAuth Core: All Token requests and Protected Resources requests MUST be signed
-         * by the Consumer and verified by the Service Provider.
-         *
-         * The protocol defines three signature methods: HMAC-SHA1, RSA-SHA1, and PLAINTEXT..
-         *
-         * The Consumer declares a signature method in the oauth_signature_method parameter..
-         *
-         * http://oauth.net/core/1.0a/#signing_process
-         */
-        $this->sha1Method = new OAuthSignatureMethodHMACSHA1();
-
-        $this->OAuthConsumer = new OAuthConsumer(
-            $this->consumerKey,
-            $this->consumerSecret
-        );
-
-        if ($this->getStoredData('request_token')) {
-            $this->consumerToken = new OAuthConsumer(
-                $this->getStoredData('request_token'),
-                $this->getStoredData('request_token_secret')
-            );
-        }
-
-        if ($this->getStoredData('access_token')) {
-            $this->consumerToken = new OAuthConsumer(
-                $this->getStoredData('access_token'),
-                $this->getStoredData('access_token_secret')
-            );
-        }
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function authenticate()
-    {
-        $this->logger->info(sprintf('%s::authenticate()', get_class($this)));
-
-        if ($this->isConnected()) {
-            return true;
-        }
-
-        try {
-            if (!$this->getStoredData('request_token')) {
-                // Start a new flow.
-                $this->authenticateBegin();
-            } elseif (empty($_GET['oauth_token']) && empty($_GET['denied'])) {
-                // A previous authentication was not finished, and this request is not finishing it.
-                $this->authenticateBegin();
-            } else {
-                // Finish a flow.
-                $this->authenticateFinish();
-            }
-        } catch (Exception $exception) {
-            $this->clearStoredData();
-
-            throw $exception;
-        }
-
-        return null;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function isConnected()
-    {
-        return (bool)$this->getStoredData('access_token');
-    }
-
-    /**
-     * Initiate the authorization protocol
-     *
-     * 1. Obtaining an Unauthorized Request Token
-     * 2. Build Authorization URL for Authorization Request and redirect the user-agent to the
-     *    Authorization Server.
-     */
-    protected function authenticateBegin()
-    {
-        $response = $this->requestAuthToken();
-
-        $this->validateAuthTokenRequest($response);
-
-        $authUrl = $this->getAuthorizeUrl();
-
-        $this->logger->debug(sprintf('%s::authenticateBegin(), redirecting user to:', get_class($this)), [$authUrl]);
-
-        HttpClient\Util::redirect($authUrl);
-    }
-
-    /**
-     * Finalize the authorization process
-     *
-     * @throws AuthorizationDeniedException
-     * @throws \Hybridauth\Exception\HttpClientFailureException
-     * @throws \Hybridauth\Exception\HttpRequestFailedException
-     * @throws InvalidAccessTokenException
-     * @throws InvalidOauthTokenException
-     */
-    protected function authenticateFinish()
-    {
-        $this->logger->debug(
-            sprintf('%s::authenticateFinish(), callback url:', get_class($this)),
-            [HttpClient\Util::getCurrentUrl(true)]
-        );
-
-        $denied = filter_input(INPUT_GET, 'denied');
-        $oauth_problem = filter_input(INPUT_GET, 'oauth_problem');
-        $oauth_token = filter_input(INPUT_GET, 'oauth_token');
-        $oauth_verifier = filter_input(INPUT_GET, 'oauth_verifier');
-
-        if ($denied) {
-            throw new AuthorizationDeniedException(
-                'User denied access request. Provider returned a denied token: ' . htmlentities($denied)
-            );
-        }
-
-        if ($oauth_problem) {
-            throw new InvalidOauthTokenException(
-                'Provider returned an error. oauth_problem: ' . htmlentities($oauth_problem)
-            );
-        }
-
-        if (!$oauth_token) {
-            throw new InvalidOauthTokenException(
-                'Expecting a non-null oauth_token to continue the authorization flow.'
-            );
-        }
-
-        $response = $this->exchangeAuthTokenForAccessToken($oauth_token, $oauth_verifier);
-
-        $this->validateAccessTokenExchange($response);
-
-        $this->initialize();
-    }
-
-    /**
-     * Build Authorization URL for Authorization Request
-     *
-     * @param array $parameters
-     *
-     * @return string
-     */
-    protected function getAuthorizeUrl($parameters = [])
-    {
-        $this->AuthorizeUrlParameters = !empty($parameters)
-            ? $parameters
-            : array_replace(
-                (array)$this->AuthorizeUrlParameters,
-                (array)$this->config->get('authorize_url_parameters')
-            );
-
-        $this->AuthorizeUrlParameters['oauth_token'] = $this->getStoredData('request_token');
-
-        return $this->authorizeUrl . '?' . http_build_query($this->AuthorizeUrlParameters, '', '&');
-    }
-
-    /**
-     * Unauthorized Request Token
-     *
-     * OAuth Core: The Consumer obtains an unauthorized Request Token by asking the Service Provider
-     * to issue a Token. The Request Token's sole purpose is to receive User approval and can only
-     * be used to obtain an Access Token.
-     *
-     * http://oauth.net/core/1.0/#auth_step1
-     * 6.1.1. Consumer Obtains a Request Token
-     *
-     * @return string Raw Provider API response
-     * @throws \Hybridauth\Exception\HttpClientFailureException
-     * @throws \Hybridauth\Exception\HttpRequestFailedException
-     */
-    protected function requestAuthToken()
-    {
-        /**
-         * OAuth Core 1.0 Revision A: oauth_callback: An absolute URL to which the Service Provider will redirect
-         * the User back when the Obtaining User Authorization step is completed.
-         *
-         * http://oauth.net/core/1.0a/#auth_step1
-         */
-        if ('1.0a' == $this->oauth1Version) {
-            $this->requestTokenParameters['oauth_callback'] = $this->callback;
-        }
-
-        $response = $this->oauthRequest(
-            $this->requestTokenUrl,
-            $this->requestTokenMethod,
-            $this->requestTokenParameters,
-            $this->requestTokenHeaders
-        );
-
-        return $response;
-    }
-
-    /**
-     * Validate Unauthorized Request Token Response
-     *
-     * OAuth Core: The Service Provider verifies the signature and Consumer Key. If successful,
-     * it generates a Request Token and Token Secret and returns them to the Consumer in the HTTP
-     * response body.
-     *
-     * http://oauth.net/core/1.0/#auth_step1
-     * 6.1.2. Service Provider Issues an Unauthorized Request Token
-     *
-     * @param string $response
-     *
-     * @return \Hybridauth\Data\Collection
-     * @throws InvalidOauthTokenException
-     */
-    protected function validateAuthTokenRequest($response)
-    {
-        /**
-         * The response contains the following parameters:
-         *
-         *    - oauth_token               The Request Token.
-         *    - oauth_token_secret        The Token Secret.
-         *    - oauth_callback_confirmed  MUST be present and set to true.
-         *
-         * http://oauth.net/core/1.0/#auth_step1
-         * 6.1.2. Service Provider Issues an Unauthorized Request Token
-         *
-         * Example of a successful response:
-         *
-         *  HTTP/1.1 200 OK
-         *  Content-Type: text/html; charset=utf-8
-         *  Cache-Control: no-store
-         *  Pragma: no-cache
-         *
-         *  oauth_token=80359084-clg1DEtxQF3wstTcyUdHF3wsdHM&oauth_token_secret=OIF07hPmJB:P
-         *  6qiHTi1znz6qiH3tTcyUdHnz6qiH3tTcyUdH3xW3wsDvV08e&example_parameter=example_value
-         *
-         * OAuthUtil::parse_parameters will attempt to decode the raw response into an array.
-         */
-        $tokens = OAuthUtil::parse_parameters($response);
-
-        $collection = new Data\Collection($tokens);
-
-        if (!$collection->exists('oauth_token')) {
-            throw new InvalidOauthTokenException(
-                'Provider returned no oauth_token: ' . htmlentities($response)
-            );
-        }
-
-        $this->consumerToken = new OAuthConsumer(
-            $tokens['oauth_token'],
-            $tokens['oauth_token_secret']
-        );
-
-        $this->storeData('request_token', $tokens['oauth_token']);
-        $this->storeData('request_token_secret', $tokens['oauth_token_secret']);
-
-        return $collection;
-    }
-
-    /**
-     * Requests an Access Token
-     *
-     * OAuth Core: The Request Token and Token Secret MUST be exchanged for an Access Token and Token Secret.
-     *
-     * http://oauth.net/core/1.0a/#auth_step3
-     * 6.3.1. Consumer Requests an Access Token
-     *
-     * @param string $oauth_token
-     * @param string $oauth_verifier
-     *
-     * @return string Raw Provider API response
-     * @throws \Hybridauth\Exception\HttpClientFailureException
-     * @throws \Hybridauth\Exception\HttpRequestFailedException
-     */
-    protected function exchangeAuthTokenForAccessToken($oauth_token, $oauth_verifier = '')
-    {
-        $this->tokenExchangeParameters['oauth_token'] = $oauth_token;
-
-        /**
-         * OAuth Core 1.0 Revision A: oauth_verifier: The verification code received from the Service Provider
-         * in the "Service Provider Directs the User Back to the Consumer" step.
-         *
-         * http://oauth.net/core/1.0a/#auth_step3
-         */
-        if ('1.0a' == $this->oauth1Version) {
-            $this->tokenExchangeParameters['oauth_verifier'] = $oauth_verifier;
-        }
-
-        $response = $this->oauthRequest(
-            $this->accessTokenUrl,
-            $this->tokenExchangeMethod,
-            $this->tokenExchangeParameters,
-            $this->tokenExchangeHeaders
-        );
-
-        return $response;
-    }
-
-    /**
-     * Validate Access Token Response
-     *
-     * OAuth Core: If successful, the Service Provider generates an Access Token and Token Secret and returns
-     * them in the HTTP response body.
-     *
-     * The Access Token and Token Secret are stored by the Consumer and used when signing Protected Resources requests.
-     *
-     * http://oauth.net/core/1.0a/#auth_step3
-     * 6.3.2. Service Provider Grants an Access Token
-     *
-     * @param string $response
-     *
-     * @return \Hybridauth\Data\Collection
-     * @throws InvalidAccessTokenException
-     */
-    protected function validateAccessTokenExchange($response)
-    {
-        /**
-         * The response contains the following parameters:
-         *
-         *    - oauth_token         The Access Token.
-         *    - oauth_token_secret  The Token Secret.
-         *
-         * http://oauth.net/core/1.0/#auth_step3
-         * 6.3.2. Service Provider Grants an Access Token
-         *
-         * Example of a successful response:
-         *
-         *  HTTP/1.1 200 OK
-         *  Content-Type: text/html; charset=utf-8
-         *  Cache-Control: no-store
-         *  Pragma: no-cache
-         *
-         *  oauth_token=sHeLU7Far428zj8PzlWR75&oauth_token_secret=fXb30rzoG&oauth_callback_confirmed=true
-         *
-         * OAuthUtil::parse_parameters will attempt to decode the raw response into an array.
-         */
-        $tokens = OAuthUtil::parse_parameters($response);
-
-        $collection = new Data\Collection($tokens);
-
-        if (!$collection->exists('oauth_token')) {
-            throw new InvalidAccessTokenException(
-                'Provider returned no access_token: ' . htmlentities($response)
-            );
-        }
-
-        $this->consumerToken = new OAuthConsumer(
-            $collection->get('oauth_token'),
-            $collection->get('oauth_token_secret')
-        );
-
-        $this->storeData('access_token', $collection->get('oauth_token'));
-        $this->storeData('access_token_secret', $collection->get('oauth_token_secret'));
-
-        $this->deleteStoredData('request_token');
-        $this->deleteStoredData('request_token_secret');
-
-        return $collection;
-    }
-
-    /**
-     * Send a signed request to provider API
-     *
-     * Note: Since the specifics of error responses is beyond the scope of RFC6749 and OAuth specifications,
-     * Hybridauth will consider any HTTP status code that is different than '200 OK' as an ERROR.
-     *
-     * @param string $url
-     * @param string $method
-     * @param array $parameters
-     * @param array $headers
-     * @param bool $multipart
-     *
-     * @return mixed
-     * @throws \Hybridauth\Exception\HttpClientFailureException
-     * @throws \Hybridauth\Exception\HttpRequestFailedException
-     */
-    public function apiRequest($url, $method = 'GET', $parameters = [], $headers = [], $multipart = false)
-    {
-        // refresh tokens if needed
-        $this->maintainToken();
-
-        if (strrpos($url, 'http://') !== 0 && strrpos($url, 'https://') !== 0) {
-            $url = rtrim($this->apiBaseUrl, '/') . '/' . ltrim($url, '/');
-        }
-
-        $parameters = array_replace($this->apiRequestParameters, (array)$parameters);
-
-        $headers = array_replace($this->apiRequestHeaders, (array)$headers);
-
-        $response = $this->oauthRequest($url, $method, $parameters, $headers, $multipart);
-
-        $response = (new Data\Parser())->parse($response);
-
-        return $response;
-    }
-
-    /**
-     * Setup and Send a Signed Oauth Request
-     *
-     * This method uses OAuth Library.
-     *
-     * @param string $uri
-     * @param string $method
-     * @param array $parameters
-     * @param array $headers
-     * @param bool $multipart
-     *
-     * @return string Raw Provider API response
-     * @throws \Hybridauth\Exception\HttpClientFailureException
-     * @throws \Hybridauth\Exception\HttpRequestFailedException
-     */
-    protected function oauthRequest($uri, $method = 'GET', $parameters = [], $headers = [], $multipart = false)
-    {
-        $signing_parameters = $parameters;
-        if ($multipart) {
-            $signing_parameters = [];
-        }
-
-        $request = OAuthRequest::from_consumer_and_token(
-            $this->OAuthConsumer,
-            $this->consumerToken,
-            $method,
-            $uri,
-            $signing_parameters
-        );
-
-        $request->sign_request(
-            $this->sha1Method,
-            $this->OAuthConsumer,
-            $this->consumerToken
-        );
-
-        $uri = $request->get_normalized_http_url();
-        $headers = array_replace($request->to_header(), (array)$headers);
-
-        $response = $this->httpClient->request(
-            $uri,
-            $method,
-            $parameters,
-            $headers,
-            $multipart
-        );
-
-        $this->validateApiResponse('Signed API request to ' . $uri . ' has returned an error');
-
-        return $response;
-    }
+	/**
+	 * Base URL to provider API
+	 *
+	 * This var will be used to build urls when sending signed requests
+	 *
+	 * @var string
+	 */
+	protected $apiBaseUrl = '';
+
+	/**
+	 * @var string
+	 */
+	protected $authorizeUrl = '';
+
+	/**
+	 * @var string
+	 */
+	protected $requestTokenUrl = '';
+
+	/**
+	 * @var string
+	 */
+	protected $accessTokenUrl = '';
+
+	/**
+	 * IPD API Documentation
+	 *
+	 * OPTIONAL.
+	 *
+	 * @var string
+	 */
+	protected $apiDocumentation = '';
+
+	/**
+	 * OAuth Version
+	 *
+	 *  '1.0' OAuth Core 1.0
+	 * '1.0a' OAuth Core 1.0 Revision A
+	 *
+	 * @var string
+	 */
+	protected $oauth1Version = '1.0a';
+
+	/**
+	 * @var string
+	 */
+	protected $consumerKey = null;
+
+	/**
+	 * @var string
+	 */
+	protected $consumerSecret = null;
+
+	/**
+	 * @var object
+	 */
+	protected $OAuthConsumer = null;
+
+	/**
+	 * @var object
+	 */
+	protected $sha1Method = null;
+
+	/**
+	 * @var object
+	 */
+	protected $consumerToken = null;
+
+	/**
+	 * Authorization Url Parameters
+	 *
+	 * @var bool
+	 */
+	protected $AuthorizeUrlParameters = [];
+
+	/**
+	 * @var string
+	 */
+	protected $requestTokenMethod = 'POST';
+
+	/**
+	 * @var array
+	 */
+	protected $requestTokenParameters = [];
+
+	/**
+	 * @var array
+	 */
+	protected $requestTokenHeaders = [];
+
+	/**
+	 * @var string
+	 */
+	protected $tokenExchangeMethod = 'POST';
+
+	/**
+	 * @var array
+	 */
+	protected $tokenExchangeParameters = [];
+
+	/**
+	 * @var array
+	 */
+	protected $tokenExchangeHeaders = [];
+
+	/**
+	 * @var array
+	 */
+	protected $apiRequestParameters = [];
+
+	/**
+	 * @var array
+	 */
+	protected $apiRequestHeaders = [];
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function configure()
+	{
+		$this->consumerKey = $this->config->filter('keys')->get('id') ?: $this->config->filter('keys')->get('key');
+		$this->consumerSecret = $this->config->filter('keys')->get('secret');
+
+		if (!$this->consumerKey || !$this->consumerSecret) {
+			throw new InvalidApplicationCredentialsException(
+				'Your application id is required in order to connect to ' . $this->providerId
+			);
+		}
+
+		if ($this->config->exists('tokens')) {
+			$this->setAccessToken($this->config->get('tokens'));
+		}
+
+		$this->setCallback($this->config->get('callback'));
+		$this->setApiEndpoints($this->config->get('endpoints'));
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function initialize()
+	{
+		/**
+		 * Set up OAuth Signature and Consumer
+		 *
+		 * OAuth Core: All Token requests and Protected Resources requests MUST be signed
+		 * by the Consumer and verified by the Service Provider.
+		 *
+		 * The protocol defines three signature methods: HMAC-SHA1, RSA-SHA1, and PLAINTEXT..
+		 *
+		 * The Consumer declares a signature method in the oauth_signature_method parameter..
+		 *
+		 * http://oauth.net/core/1.0a/#signing_process
+		 */
+		$this->sha1Method = new OAuthSignatureMethodHMACSHA1();
+
+		$this->OAuthConsumer = new OAuthConsumer(
+			$this->consumerKey,
+			$this->consumerSecret
+		);
+
+		if ($this->getStoredData('request_token')) {
+			$this->consumerToken = new OAuthConsumer(
+				$this->getStoredData('request_token'),
+				$this->getStoredData('request_token_secret')
+			);
+		}
+
+		if ($this->getStoredData('access_token')) {
+			$this->consumerToken = new OAuthConsumer(
+				$this->getStoredData('access_token'),
+				$this->getStoredData('access_token_secret')
+			);
+		}
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function authenticate()
+	{
+		$this->logger->info(sprintf('%s::authenticate()', get_class($this)));
+
+		if ($this->isConnected()) {
+			return true;
+		}
+
+		try {
+			if (!$this->getStoredData('request_token')) {
+				// Start a new flow.
+				$this->authenticateBegin();
+			} elseif (empty($_GET['oauth_token']) && empty($_GET['denied'])) {
+				// A previous authentication was not finished, and this request is not finishing it.
+				$this->authenticateBegin();
+			} else {
+				// Finish a flow.
+				$this->authenticateFinish();
+			}
+		} catch (Exception $exception) {
+			$this->clearStoredData();
+
+			throw $exception;
+		}
+
+		return null;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function isConnected()
+	{
+		return (bool)$this->getStoredData('access_token');
+	}
+
+	/**
+	 * Initiate the authorization protocol
+	 *
+	 * 1. Obtaining an Unauthorized Request Token
+	 * 2. Build Authorization URL for Authorization Request and redirect the user-agent to the
+	 *    Authorization Server.
+	 */
+	protected function authenticateBegin()
+	{
+		$response = $this->requestAuthToken();
+
+		$this->validateAuthTokenRequest($response);
+
+		$authUrl = $this->getAuthorizeUrl();
+
+		$this->logger->debug(sprintf('%s::authenticateBegin(), redirecting user to:', get_class($this)), [$authUrl]);
+
+		HttpClient\Util::redirect($authUrl);
+	}
+
+	/**
+	 * Finalize the authorization process
+	 *
+	 * @throws AuthorizationDeniedException
+	 * @throws \Hybridauth\Exception\HttpClientFailureException
+	 * @throws \Hybridauth\Exception\HttpRequestFailedException
+	 * @throws InvalidAccessTokenException
+	 * @throws InvalidOauthTokenException
+	 */
+	protected function authenticateFinish()
+	{
+		$this->logger->debug(
+			sprintf('%s::authenticateFinish(), callback url:', get_class($this)),
+			[HttpClient\Util::getCurrentUrl(true)]
+		);
+
+		$denied = filter_input(INPUT_GET, 'denied');
+		$oauth_problem = filter_input(INPUT_GET, 'oauth_problem');
+		$oauth_token = filter_input(INPUT_GET, 'oauth_token');
+		$oauth_verifier = filter_input(INPUT_GET, 'oauth_verifier');
+
+		if ($denied) {
+			throw new AuthorizationDeniedException(
+				'User denied access request. Provider returned a denied token: ' . htmlentities($denied)
+			);
+		}
+
+		if ($oauth_problem) {
+			throw new InvalidOauthTokenException(
+				'Provider returned an error. oauth_problem: ' . htmlentities($oauth_problem)
+			);
+		}
+
+		if (!$oauth_token) {
+			throw new InvalidOauthTokenException(
+				'Expecting a non-null oauth_token to continue the authorization flow.'
+			);
+		}
+
+		$response = $this->exchangeAuthTokenForAccessToken($oauth_token, $oauth_verifier);
+
+		$this->validateAccessTokenExchange($response);
+
+		$this->initialize();
+	}
+
+	/**
+	 * Build Authorization URL for Authorization Request
+	 *
+	 * @param array $parameters
+	 *
+	 * @return string
+	 */
+	protected function getAuthorizeUrl($parameters = [])
+	{
+		$this->AuthorizeUrlParameters = !empty($parameters)
+			? $parameters
+			: array_replace(
+				(array)$this->AuthorizeUrlParameters,
+				(array)$this->config->get('authorize_url_parameters')
+			);
+
+		$this->AuthorizeUrlParameters['oauth_token'] = $this->getStoredData('request_token');
+
+		return $this->authorizeUrl . '?' . http_build_query($this->AuthorizeUrlParameters, '', '&');
+	}
+
+	/**
+	 * Unauthorized Request Token
+	 *
+	 * OAuth Core: The Consumer obtains an unauthorized Request Token by asking the Service Provider
+	 * to issue a Token. The Request Token's sole purpose is to receive User approval and can only
+	 * be used to obtain an Access Token.
+	 *
+	 * http://oauth.net/core/1.0/#auth_step1
+	 * 6.1.1. Consumer Obtains a Request Token
+	 *
+	 * @return string Raw Provider API response
+	 * @throws \Hybridauth\Exception\HttpClientFailureException
+	 * @throws \Hybridauth\Exception\HttpRequestFailedException
+	 */
+	protected function requestAuthToken()
+	{
+		/**
+		 * OAuth Core 1.0 Revision A: oauth_callback: An absolute URL to which the Service Provider will redirect
+		 * the User back when the Obtaining User Authorization step is completed.
+		 *
+		 * http://oauth.net/core/1.0a/#auth_step1
+		 */
+		if ('1.0a' == $this->oauth1Version) {
+			$this->requestTokenParameters['oauth_callback'] = $this->callback;
+		}
+
+		$response = $this->oauthRequest(
+			$this->requestTokenUrl,
+			$this->requestTokenMethod,
+			$this->requestTokenParameters,
+			$this->requestTokenHeaders
+		);
+
+		return $response;
+	}
+
+	/**
+	 * Validate Unauthorized Request Token Response
+	 *
+	 * OAuth Core: The Service Provider verifies the signature and Consumer Key. If successful,
+	 * it generates a Request Token and Token Secret and returns them to the Consumer in the HTTP
+	 * response body.
+	 *
+	 * http://oauth.net/core/1.0/#auth_step1
+	 * 6.1.2. Service Provider Issues an Unauthorized Request Token
+	 *
+	 * @param string $response
+	 *
+	 * @return \Hybridauth\Data\Collection
+	 * @throws InvalidOauthTokenException
+	 */
+	protected function validateAuthTokenRequest($response)
+	{
+		/**
+		 * The response contains the following parameters:
+		 *
+		 *    - oauth_token               The Request Token.
+		 *    - oauth_token_secret        The Token Secret.
+		 *    - oauth_callback_confirmed  MUST be present and set to true.
+		 *
+		 * http://oauth.net/core/1.0/#auth_step1
+		 * 6.1.2. Service Provider Issues an Unauthorized Request Token
+		 *
+		 * Example of a successful response:
+		 *
+		 *  HTTP/1.1 200 OK
+		 *  Content-Type: text/html; charset=utf-8
+		 *  Cache-Control: no-store
+		 *  Pragma: no-cache
+		 *
+		 *  oauth_token=80359084-clg1DEtxQF3wstTcyUdHF3wsdHM&oauth_token_secret=OIF07hPmJB:P
+		 *  6qiHTi1znz6qiH3tTcyUdHnz6qiH3tTcyUdH3xW3wsDvV08e&example_parameter=example_value
+		 *
+		 * OAuthUtil::parse_parameters will attempt to decode the raw response into an array.
+		 */
+		$tokens = OAuthUtil::parse_parameters($response);
+
+		$collection = new Data\Collection($tokens);
+
+		if (!$collection->exists('oauth_token')) {
+			throw new InvalidOauthTokenException(
+				'Provider returned no oauth_token: ' . htmlentities($response)
+			);
+		}
+
+		$this->consumerToken = new OAuthConsumer(
+			$tokens['oauth_token'],
+			$tokens['oauth_token_secret']
+		);
+
+		$this->storeData('request_token', $tokens['oauth_token']);
+		$this->storeData('request_token_secret', $tokens['oauth_token_secret']);
+
+		return $collection;
+	}
+
+	/**
+	 * Requests an Access Token
+	 *
+	 * OAuth Core: The Request Token and Token Secret MUST be exchanged for an Access Token and Token Secret.
+	 *
+	 * http://oauth.net/core/1.0a/#auth_step3
+	 * 6.3.1. Consumer Requests an Access Token
+	 *
+	 * @param string $oauth_token
+	 * @param string $oauth_verifier
+	 *
+	 * @return string Raw Provider API response
+	 * @throws \Hybridauth\Exception\HttpClientFailureException
+	 * @throws \Hybridauth\Exception\HttpRequestFailedException
+	 */
+	protected function exchangeAuthTokenForAccessToken($oauth_token, $oauth_verifier = '')
+	{
+		$this->tokenExchangeParameters['oauth_token'] = $oauth_token;
+
+		/**
+		 * OAuth Core 1.0 Revision A: oauth_verifier: The verification code received from the Service Provider
+		 * in the "Service Provider Directs the User Back to the Consumer" step.
+		 *
+		 * http://oauth.net/core/1.0a/#auth_step3
+		 */
+		if ('1.0a' == $this->oauth1Version) {
+			$this->tokenExchangeParameters['oauth_verifier'] = $oauth_verifier;
+		}
+
+		$response = $this->oauthRequest(
+			$this->accessTokenUrl,
+			$this->tokenExchangeMethod,
+			$this->tokenExchangeParameters,
+			$this->tokenExchangeHeaders
+		);
+
+		return $response;
+	}
+
+	/**
+	 * Validate Access Token Response
+	 *
+	 * OAuth Core: If successful, the Service Provider generates an Access Token and Token Secret and returns
+	 * them in the HTTP response body.
+	 *
+	 * The Access Token and Token Secret are stored by the Consumer and used when signing Protected Resources requests.
+	 *
+	 * http://oauth.net/core/1.0a/#auth_step3
+	 * 6.3.2. Service Provider Grants an Access Token
+	 *
+	 * @param string $response
+	 *
+	 * @return \Hybridauth\Data\Collection
+	 * @throws InvalidAccessTokenException
+	 */
+	protected function validateAccessTokenExchange($response)
+	{
+		/**
+		 * The response contains the following parameters:
+		 *
+		 *    - oauth_token         The Access Token.
+		 *    - oauth_token_secret  The Token Secret.
+		 *
+		 * http://oauth.net/core/1.0/#auth_step3
+		 * 6.3.2. Service Provider Grants an Access Token
+		 *
+		 * Example of a successful response:
+		 *
+		 *  HTTP/1.1 200 OK
+		 *  Content-Type: text/html; charset=utf-8
+		 *  Cache-Control: no-store
+		 *  Pragma: no-cache
+		 *
+		 *  oauth_token=sHeLU7Far428zj8PzlWR75&oauth_token_secret=fXb30rzoG&oauth_callback_confirmed=true
+		 *
+		 * OAuthUtil::parse_parameters will attempt to decode the raw response into an array.
+		 */
+		$tokens = OAuthUtil::parse_parameters($response);
+
+		$collection = new Data\Collection($tokens);
+
+		if (!$collection->exists('oauth_token')) {
+			throw new InvalidAccessTokenException(
+				'Provider returned no access_token: ' . htmlentities($response)
+			);
+		}
+
+		$this->consumerToken = new OAuthConsumer(
+			$collection->get('oauth_token'),
+			$collection->get('oauth_token_secret')
+		);
+
+		$this->storeData('access_token', $collection->get('oauth_token'));
+		$this->storeData('access_token_secret', $collection->get('oauth_token_secret'));
+
+		$this->deleteStoredData('request_token');
+		$this->deleteStoredData('request_token_secret');
+
+		return $collection;
+	}
+
+	/**
+	 * Send a signed request to provider API
+	 *
+	 * Note: Since the specifics of error responses is beyond the scope of RFC6749 and OAuth specifications,
+	 * Hybridauth will consider any HTTP status code that is different than '200 OK' as an ERROR.
+	 *
+	 * @param string $url
+	 * @param string $method
+	 * @param array $parameters
+	 * @param array $headers
+	 * @param bool $multipart
+	 *
+	 * @return mixed
+	 * @throws \Hybridauth\Exception\HttpClientFailureException
+	 * @throws \Hybridauth\Exception\HttpRequestFailedException
+	 */
+	public function apiRequest($url, $method = 'GET', $parameters = [], $headers = [], $multipart = false)
+	{
+		// refresh tokens if needed
+		$this->maintainToken();
+
+		if (strrpos($url, 'http://') !== 0 && strrpos($url, 'https://') !== 0) {
+			$url = rtrim($this->apiBaseUrl, '/') . '/' . ltrim($url, '/');
+		}
+
+		$parameters = array_replace($this->apiRequestParameters, (array)$parameters);
+
+		$headers = array_replace($this->apiRequestHeaders, (array)$headers);
+
+		$response = $this->oauthRequest($url, $method, $parameters, $headers, $multipart);
+
+		$response = (new Data\Parser())->parse($response);
+
+		return $response;
+	}
+
+	/**
+	 * Setup and Send a Signed Oauth Request
+	 *
+	 * This method uses OAuth Library.
+	 *
+	 * @param string $uri
+	 * @param string $method
+	 * @param array $parameters
+	 * @param array $headers
+	 * @param bool $multipart
+	 *
+	 * @return string Raw Provider API response
+	 * @throws \Hybridauth\Exception\HttpClientFailureException
+	 * @throws \Hybridauth\Exception\HttpRequestFailedException
+	 */
+	protected function oauthRequest($uri, $method = 'GET', $parameters = [], $headers = [], $multipart = false)
+	{
+		$signing_parameters = $parameters;
+		if ($multipart) {
+			$signing_parameters = [];
+		}
+
+		$request = OAuthRequest::from_consumer_and_token(
+			$this->OAuthConsumer,
+			$this->consumerToken,
+			$method,
+			$uri,
+			$signing_parameters
+		);
+
+		$request->sign_request(
+			$this->sha1Method,
+			$this->OAuthConsumer,
+			$this->consumerToken
+		);
+
+		$uri = $request->get_normalized_http_url();
+		$headers = array_replace($request->to_header(), (array)$headers);
+
+		$response = $this->httpClient->request(
+			$uri,
+			$method,
+			$parameters,
+			$headers,
+			$multipart
+		);
+
+		$this->validateApiResponse('Signed API request to ' . $uri . ' has returned an error');
+
+		return $response;
+	}
 }

src/Provider/Patreon.php

Indentation +173 added lines, -173 removed lines

@@ -18,177 +18,177 @@
  */
 class Patreon extends OAuth2
 {
-    /**
-     * {@inheritdoc}
-     */
-    protected $scope = 'identity identity[email]';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected $apiBaseUrl = 'https://www.patreon.com/api';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected $authorizeUrl = 'https://www.patreon.com/oauth2/authorize';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected $accessTokenUrl = 'https://www.patreon.com/api/oauth2/token';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected $apiDocumentation = 'https://docs.patreon.com/#oauth';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected function initialize()
-    {
-        parent::initialize();
-
-        if ($this->isRefreshTokenAvailable()) {
-            $this->tokenRefreshParameters += [
-                'client_id' => $this->clientId,
-                'client_secret' => $this->clientSecret,
-            ];
-        }
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getUserProfile()
-    {
-        $response = $this->apiRequest('oauth2/v2/identity', 'GET', [
-            'fields[user]' => 'created,first_name,last_name,email,full_name,is_email_verified,thumb_url,url',
-        ]);
-
-        $collection = new Collection($response);
-        if (!$collection->exists('data')) {
-            throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
-        }
-
-        $userProfile = new Profile();
-
-        $data = $collection->filter('data');
-        $attributes = $data->filter('attributes');
-
-        $userProfile->identifier = $data->get('id');
-        $userProfile->email = $attributes->get('email');
-        $userProfile->firstName = $attributes->get('first_name');
-        $userProfile->lastName = $attributes->get('last_name');
-        $userProfile->displayName = $attributes->get('full_name') ?: $data->get('id');
-        $userProfile->photoURL = $attributes->get('thumb_url');
-        $userProfile->profileURL = $attributes->get('url');
-
-        $userProfile->emailVerified = $attributes->get('is_email_verified') ? $userProfile->email : '';
-
-        return $userProfile;
-    }
-
-    /**
-     * Contacts are defined as Patrons here
-     */
-    public function getUserContacts()
-    {
-        $campaignId = $this->config->get('campaign_id') ?: null;
-        $tierFilter = $this->config->get('tier_filter') ?: null;
-
-        $campaigns = [];
-        if ($campaignId === null) {
-            $campaignsUrl = 'oauth2/v2/campaigns';
-            do {
-                $response = $this->apiRequest($campaignsUrl);
-                $data = new Collection($response);
-
-                if (!$data->exists('data')) {
-                    throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
-                }
-
-                foreach ($data->filter('data')->toArray() as $item) {
-                    $campaign = new Collection($item);
-                    $campaigns[] = $campaign->get('id');
-                }
-
-                if ($data->filter('links')->exists('next')) {
-                    $campaignsUrl = $data->filter('links')->get('next');
-
-                    $pagedList = true;
-                } else {
-                    $pagedList = false;
-                }
-            } while ($pagedList);
-        } else {
-            $campaigns[] = $campaignId;
-        }
-
-        $contacts = [];
-
-        foreach ($campaigns as $campaignId) {
-            $params = [
-                'include' => 'currently_entitled_tiers',
-                'fields[member]' => 'full_name,patron_status,email',
-                'fields[tier]' => 'title',
-            ];
-            $membersUrl = 'oauth2/v2/campaigns/' . $campaignId . '/members?' . http_build_query($params);
-
-            do {
-                $response = $this->apiRequest($membersUrl);
-
-                $data = new Collection($response);
-
-                if (!$data->exists('data')) {
-                    throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
-                }
-
-                $tierTitles = [];
-
-                foreach ($data->filter('included')->toArray() as $item) {
-                    $includedItem = new Collection($item);
-                    if ($includedItem->get('type') == 'tier') {
-                        $tierTitles[$includedItem->get('id')] = $includedItem->filter('attributes')->get('title');
-                    }
-                }
-
-                foreach ($data->filter('data')->toArray() as $item) {
-                    $member = new Collection($item);
-
-                    if ($member->filter('attributes')->get('patron_status') == 'active_patron') {
-                        $tiers = [];
-                        $tierObs = $member->filter('relationships')->filter('currently_entitled_tiers')->get('data');
-                        foreach ($tierObs as $item) {
-                            $tier = new Collection($item);
-                            $tierId = $tier->get('id');
-                            $tiers[] = $tierTitles[$tierId];
-                        }
-
-                        if (($tierFilter === null) || (in_array($tierFilter, $tiers))) {
-                            $userContact = new User\Contact();
-
-                            $userContact->identifier = $member->get('id');
-                            $userContact->email = $member->filter('attributes')->get('email');
-                            $userContact->displayName = $member->filter('attributes')->get('full_name');
-                            $userContact->description = json_encode($tiers);
-
-                            $contacts[] = $userContact;
-                        }
-                    }
-                }
-
-                if ($data->filter('links')->exists('next')) {
-                    $membersUrl = $data->filter('links')->get('next');
-
-                    $pagedList = true;
-                } else {
-                    $pagedList = false;
-                }
-            } while ($pagedList);
-        }
-
-        return $contacts;
-    }
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $scope = 'identity identity[email]';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $apiBaseUrl = 'https://www.patreon.com/api';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $authorizeUrl = 'https://www.patreon.com/oauth2/authorize';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $accessTokenUrl = 'https://www.patreon.com/api/oauth2/token';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $apiDocumentation = 'https://docs.patreon.com/#oauth';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function initialize()
+	{
+		parent::initialize();
+
+		if ($this->isRefreshTokenAvailable()) {
+			$this->tokenRefreshParameters += [
+				'client_id' => $this->clientId,
+				'client_secret' => $this->clientSecret,
+			];
+		}
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getUserProfile()
+	{
+		$response = $this->apiRequest('oauth2/v2/identity', 'GET', [
+			'fields[user]' => 'created,first_name,last_name,email,full_name,is_email_verified,thumb_url,url',
+		]);
+
+		$collection = new Collection($response);
+		if (!$collection->exists('data')) {
+			throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
+		}
+
+		$userProfile = new Profile();
+
+		$data = $collection->filter('data');
+		$attributes = $data->filter('attributes');
+
+		$userProfile->identifier = $data->get('id');
+		$userProfile->email = $attributes->get('email');
+		$userProfile->firstName = $attributes->get('first_name');
+		$userProfile->lastName = $attributes->get('last_name');
+		$userProfile->displayName = $attributes->get('full_name') ?: $data->get('id');
+		$userProfile->photoURL = $attributes->get('thumb_url');
+		$userProfile->profileURL = $attributes->get('url');
+
+		$userProfile->emailVerified = $attributes->get('is_email_verified') ? $userProfile->email : '';
+
+		return $userProfile;
+	}
+
+	/**
+	 * Contacts are defined as Patrons here
+	 */
+	public function getUserContacts()
+	{
+		$campaignId = $this->config->get('campaign_id') ?: null;
+		$tierFilter = $this->config->get('tier_filter') ?: null;
+
+		$campaigns = [];
+		if ($campaignId === null) {
+			$campaignsUrl = 'oauth2/v2/campaigns';
+			do {
+				$response = $this->apiRequest($campaignsUrl);
+				$data = new Collection($response);
+
+				if (!$data->exists('data')) {
+					throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
+				}
+
+				foreach ($data->filter('data')->toArray() as $item) {
+					$campaign = new Collection($item);
+					$campaigns[] = $campaign->get('id');
+				}
+
+				if ($data->filter('links')->exists('next')) {
+					$campaignsUrl = $data->filter('links')->get('next');
+
+					$pagedList = true;
+				} else {
+					$pagedList = false;
+				}
+			} while ($pagedList);
+		} else {
+			$campaigns[] = $campaignId;
+		}
+
+		$contacts = [];
+
+		foreach ($campaigns as $campaignId) {
+			$params = [
+				'include' => 'currently_entitled_tiers',
+				'fields[member]' => 'full_name,patron_status,email',
+				'fields[tier]' => 'title',
+			];
+			$membersUrl = 'oauth2/v2/campaigns/' . $campaignId . '/members?' . http_build_query($params);
+
+			do {
+				$response = $this->apiRequest($membersUrl);
+
+				$data = new Collection($response);
+
+				if (!$data->exists('data')) {
+					throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
+				}
+
+				$tierTitles = [];
+
+				foreach ($data->filter('included')->toArray() as $item) {
+					$includedItem = new Collection($item);
+					if ($includedItem->get('type') == 'tier') {
+						$tierTitles[$includedItem->get('id')] = $includedItem->filter('attributes')->get('title');
+					}
+				}
+
+				foreach ($data->filter('data')->toArray() as $item) {
+					$member = new Collection($item);
+
+					if ($member->filter('attributes')->get('patron_status') == 'active_patron') {
+						$tiers = [];
+						$tierObs = $member->filter('relationships')->filter('currently_entitled_tiers')->get('data');
+						foreach ($tierObs as $item) {
+							$tier = new Collection($item);
+							$tierId = $tier->get('id');
+							$tiers[] = $tierTitles[$tierId];
+						}
+
+						if (($tierFilter === null) || (in_array($tierFilter, $tiers))) {
+							$userContact = new User\Contact();
+
+							$userContact->identifier = $member->get('id');
+							$userContact->email = $member->filter('attributes')->get('email');
+							$userContact->displayName = $member->filter('attributes')->get('full_name');
+							$userContact->description = json_encode($tiers);
+
+							$contacts[] = $userContact;
+						}
+					}
+				}
+
+				if ($data->filter('links')->exists('next')) {
+					$membersUrl = $data->filter('links')->get('next');
+
+					$pagedList = true;
+				} else {
+					$pagedList = false;
+				}
+			} while ($pagedList);
+		}
+
+		return $contacts;
+	}
 }

src/Provider/Instagram.php

Indentation +231 added lines, -231 removed lines

@@ -17,240 +17,240 @@
  */
 class Instagram extends OAuth2
 {
-    /**
-     * {@inheritdoc}
-     */
-    protected $scope = 'user_profile,user_media';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected $apiBaseUrl = 'https://graph.instagram.com';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected $authorizeUrl = 'https://api.instagram.com/oauth/authorize';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected $accessTokenUrl = 'https://api.instagram.com/oauth/access_token';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected $apiDocumentation = 'https://developers.facebook.com/docs/instagram-basic-display-api';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected function initialize()
-    {
-        parent::initialize();
-
-        // The Instagram API requires an access_token from authenticated users
-        // for each endpoint.
-        $accessToken = $this->getStoredData($this->accessTokenName);
-        $this->apiRequestParameters[$this->accessTokenName] = $accessToken;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    protected function validateAccessTokenExchange($response)
-    {
-        $collection = parent::validateAccessTokenExchange($response);
-
-        if (!$collection->exists('expires_in')) {
-            // Instagram tokens always expire in an hour, but this is implicit not explicit
-
-            $expires_in = 60 * 60;
-
-            $expires_at = time() + $expires_in;
-
-            $this->storeData('expires_in', $expires_in);
-            $this->storeData('expires_at', $expires_at);
-        }
-
-        return $collection;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function maintainToken()
-    {
-        if (!$this->isConnected()) {
-            return;
-        }
-
-        // Handle token exchange prior to the standard handler for an API request
-        $exchange_by_expiry_days = $this->config->get('exchange_by_expiry_days') ?: 45;
-        if ($exchange_by_expiry_days !== null) {
-            $projected_timestamp = time() + 60 * 60 * 24 * $exchange_by_expiry_days;
-            if (!$this->hasAccessTokenExpired() && $this->hasAccessTokenExpired($projected_timestamp)) {
-                $this->exchangeAccessToken();
-            }
-        }
-    }
-
-    /**
-     * Exchange the Access Token with one that expires further in the future.
-     *
-     * @return string Raw Provider API response
-     * @throws \Hybridauth\Exception\HttpClientFailureException
-     * @throws \Hybridauth\Exception\HttpRequestFailedException
-     * @throws InvalidAccessTokenException
-     */
-    public function exchangeAccessToken()
-    {
-        if ($this->getStoredData('expires_in') >= 5000000) {
-            /*
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $scope = 'user_profile,user_media';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $apiBaseUrl = 'https://graph.instagram.com';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $authorizeUrl = 'https://api.instagram.com/oauth/authorize';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $accessTokenUrl = 'https://api.instagram.com/oauth/access_token';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $apiDocumentation = 'https://developers.facebook.com/docs/instagram-basic-display-api';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function initialize()
+	{
+		parent::initialize();
+
+		// The Instagram API requires an access_token from authenticated users
+		// for each endpoint.
+		$accessToken = $this->getStoredData($this->accessTokenName);
+		$this->apiRequestParameters[$this->accessTokenName] = $accessToken;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function validateAccessTokenExchange($response)
+	{
+		$collection = parent::validateAccessTokenExchange($response);
+
+		if (!$collection->exists('expires_in')) {
+			// Instagram tokens always expire in an hour, but this is implicit not explicit
+
+			$expires_in = 60 * 60;
+
+			$expires_at = time() + $expires_in;
+
+			$this->storeData('expires_in', $expires_in);
+			$this->storeData('expires_at', $expires_at);
+		}
+
+		return $collection;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function maintainToken()
+	{
+		if (!$this->isConnected()) {
+			return;
+		}
+
+		// Handle token exchange prior to the standard handler for an API request
+		$exchange_by_expiry_days = $this->config->get('exchange_by_expiry_days') ?: 45;
+		if ($exchange_by_expiry_days !== null) {
+			$projected_timestamp = time() + 60 * 60 * 24 * $exchange_by_expiry_days;
+			if (!$this->hasAccessTokenExpired() && $this->hasAccessTokenExpired($projected_timestamp)) {
+				$this->exchangeAccessToken();
+			}
+		}
+	}
+
+	/**
+	 * Exchange the Access Token with one that expires further in the future.
+	 *
+	 * @return string Raw Provider API response
+	 * @throws \Hybridauth\Exception\HttpClientFailureException
+	 * @throws \Hybridauth\Exception\HttpRequestFailedException
+	 * @throws InvalidAccessTokenException
+	 */
+	public function exchangeAccessToken()
+	{
+		if ($this->getStoredData('expires_in') >= 5000000) {
+			/*
             Refresh a long-lived token (needed on Instagram, but not Facebook).
             It's not an oAuth style refresh using a refresh token.
             Actually it's really just another exchange, and invalidates the old token.
             Facebook/Instagram documentation is not very helpful at explaining that!
             */
-            $exchangeTokenParameters = [
-                'grant_type'        => 'ig_refresh_token',
-                'client_secret'     => $this->clientSecret,
-                'access_token'      => $this->getStoredData('access_token'),
-            ];
-            $url = 'https://graph.instagram.com/refresh_access_token';
-        } else {
-            // Exchange short-lived to long-lived
-            $exchangeTokenParameters = [
-                'grant_type'        => 'ig_exchange_token',
-                'client_secret'     => $this->clientSecret,
-                'access_token'      => $this->getStoredData('access_token'),
-            ];
-            $url = 'https://graph.instagram.com/access_token';
-        }
-
-        $response = $this->httpClient->request(
-            $url,
-            'GET',
-            $exchangeTokenParameters
-        );
-
-        $this->validateApiResponse('Unable to exchange the access token');
-
-        $this->validateAccessTokenExchange($response);
-
-        return $response;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getUserProfile()
-    {
-        $response = $this->apiRequest('me', 'GET', [
-            'fields' => 'id,username,account_type,media_count',
-        ]);
-
-        $data = new Collection($response);
-        if (!$data->exists('id')) {
-            throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
-        }
-
-        $userProfile = new User\Profile();
-        $userProfile->identifier = $data->get('id');
-        $userProfile->displayName = $data->get('username');
-        $userProfile->profileURL = "https://instagram.com/{$userProfile->displayName}";
-        $userProfile->data = [
-            'account_type' => $data->get('account_type'),
-            'media_count' => $data->get('media_count'),
-        ];
-
-        return $userProfile;
-    }
-
-    /**
-     * Fetch user medias.
-     *
-     * @param int $limit Number of elements per page.
-     * @param string $pageId Current pager ID.
-     * @param array|null $fields Fields to fetch per media.
-     *
-     * @return \Hybridauth\Data\Collection
-     *
-     * @throws \Hybridauth\Exception\HttpClientFailureException
-     * @throws \Hybridauth\Exception\HttpRequestFailedException
-     * @throws \Hybridauth\Exception\InvalidAccessTokenException
-     * @throws \Hybridauth\Exception\UnexpectedApiResponseException
-     */
-    public function getUserMedia($limit = 12, $pageId = null, array $fields = null)
-    {
-        if (empty($fields)) {
-            $fields = [
-                'id',
-                'caption',
-                'media_type',
-                'media_url',
-                'thumbnail_url',
-                'permalink',
-                'timestamp',
-                'username',
-            ];
-        }
-
-        $params = [
-            'fields' => implode(',', $fields),
-            'limit' => $limit,
-        ];
-        if ($pageId !== null) {
-            $params['after'] = $pageId;
-        }
-
-        $response = $this->apiRequest('me/media', 'GET', $params);
-
-        $data = new Collection($response);
-        if (!$data->exists('data')) {
-            throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
-        }
-
-        return $data;
-    }
-
-    /**
-     * Fetches a single user's media.
-     *
-     * @param string $mediaId Media ID.
-     * @param array|null $fields Fields to fetch per media.
-     *
-     * @return \Hybridauth\Data\Collection
-     *
-     * @throws \Hybridauth\Exception\HttpClientFailureException
-     * @throws \Hybridauth\Exception\HttpRequestFailedException
-     * @throws \Hybridauth\Exception\InvalidAccessTokenException
-     * @throws \Hybridauth\Exception\UnexpectedApiResponseException
-     */
-    public function getMedia($mediaId, array $fields = null)
-    {
-        if (empty($fields)) {
-            $fields = [
-                'id',
-                'caption',
-                'media_type',
-                'media_url',
-                'thumbnail_url',
-                'permalink',
-                'timestamp',
-                'username',
-            ];
-        }
-
-        $response = $this->apiRequest($mediaId, 'GET', [
-            'fields' => implode(',', $fields),
-        ]);
-
-        $data = new Collection($response);
-        if (!$data->exists('id')) {
-            throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
-        }
-
-        return $data;
-    }
+			$exchangeTokenParameters = [
+				'grant_type'        => 'ig_refresh_token',
+				'client_secret'     => $this->clientSecret,
+				'access_token'      => $this->getStoredData('access_token'),
+			];
+			$url = 'https://graph.instagram.com/refresh_access_token';
+		} else {
+			// Exchange short-lived to long-lived
+			$exchangeTokenParameters = [
+				'grant_type'        => 'ig_exchange_token',
+				'client_secret'     => $this->clientSecret,
+				'access_token'      => $this->getStoredData('access_token'),
+			];
+			$url = 'https://graph.instagram.com/access_token';
+		}
+
+		$response = $this->httpClient->request(
+			$url,
+			'GET',
+			$exchangeTokenParameters
+		);
+
+		$this->validateApiResponse('Unable to exchange the access token');
+
+		$this->validateAccessTokenExchange($response);
+
+		return $response;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getUserProfile()
+	{
+		$response = $this->apiRequest('me', 'GET', [
+			'fields' => 'id,username,account_type,media_count',
+		]);
+
+		$data = new Collection($response);
+		if (!$data->exists('id')) {
+			throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
+		}
+
+		$userProfile = new User\Profile();
+		$userProfile->identifier = $data->get('id');
+		$userProfile->displayName = $data->get('username');
+		$userProfile->profileURL = "https://instagram.com/{$userProfile->displayName}";
+		$userProfile->data = [
+			'account_type' => $data->get('account_type'),
+			'media_count' => $data->get('media_count'),
+		];
+
+		return $userProfile;
+	}
+
+	/**
+	 * Fetch user medias.
+	 *
+	 * @param int $limit Number of elements per page.
+	 * @param string $pageId Current pager ID.
+	 * @param array|null $fields Fields to fetch per media.
+	 *
+	 * @return \Hybridauth\Data\Collection
+	 *
+	 * @throws \Hybridauth\Exception\HttpClientFailureException
+	 * @throws \Hybridauth\Exception\HttpRequestFailedException
+	 * @throws \Hybridauth\Exception\InvalidAccessTokenException
+	 * @throws \Hybridauth\Exception\UnexpectedApiResponseException
+	 */
+	public function getUserMedia($limit = 12, $pageId = null, array $fields = null)
+	{
+		if (empty($fields)) {
+			$fields = [
+				'id',
+				'caption',
+				'media_type',
+				'media_url',
+				'thumbnail_url',
+				'permalink',
+				'timestamp',
+				'username',
+			];
+		}
+
+		$params = [
+			'fields' => implode(',', $fields),
+			'limit' => $limit,
+		];
+		if ($pageId !== null) {
+			$params['after'] = $pageId;
+		}
+
+		$response = $this->apiRequest('me/media', 'GET', $params);
+
+		$data = new Collection($response);
+		if (!$data->exists('data')) {
+			throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
+		}
+
+		return $data;
+	}
+
+	/**
+	 * Fetches a single user's media.
+	 *
+	 * @param string $mediaId Media ID.
+	 * @param array|null $fields Fields to fetch per media.
+	 *
+	 * @return \Hybridauth\Data\Collection
+	 *
+	 * @throws \Hybridauth\Exception\HttpClientFailureException
+	 * @throws \Hybridauth\Exception\HttpRequestFailedException
+	 * @throws \Hybridauth\Exception\InvalidAccessTokenException
+	 * @throws \Hybridauth\Exception\UnexpectedApiResponseException
+	 */
+	public function getMedia($mediaId, array $fields = null)
+	{
+		if (empty($fields)) {
+			$fields = [
+				'id',
+				'caption',
+				'media_type',
+				'media_url',
+				'thumbnail_url',
+				'permalink',
+				'timestamp',
+				'username',
+			];
+		}
+
+		$response = $this->apiRequest($mediaId, 'GET', [
+			'fields' => implode(',', $fields),
+		]);
+
+		$data = new Collection($response);
+		if (!$data->exists('id')) {
+			throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
+		}
+
+		return $data;
+	}
 }

src/Provider/AutoDesk.php

Indentation +64 added lines, -64 removed lines

@@ -17,80 +17,80 @@
  */
 class AutoDesk extends OAuth2
 {
-    /**
-     * {@inheritdoc}
-     */
-    protected $scope = 'data:read';
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $scope = 'data:read';
 
-    /**
-     * {@inheritdoc}
-     */
-    protected $apiBaseUrl = 'https://developer.api.autodesk.com/';
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $apiBaseUrl = 'https://developer.api.autodesk.com/';
 
-    /**
-     * {@inheritdoc}
-     */
-    protected $authorizeUrl
-        = 'https://developer.api.autodesk.com/authentication/v1/authorize';
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $authorizeUrl
+		= 'https://developer.api.autodesk.com/authentication/v1/authorize';
 
-    /**
-     * {@inheritdoc}
-     */
-    protected $accessTokenUrl
-        = 'https://developer.api.autodesk.com/authentication/v1/gettoken';
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $accessTokenUrl
+		= 'https://developer.api.autodesk.com/authentication/v1/gettoken';
 
-    /**
-     * {@inheritdoc}
-     */
-    protected $refreshTokenUrl
-        = 'https://developer.api.autodesk.com/authentication/v1/refreshtoken';
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $refreshTokenUrl
+		= 'https://developer.api.autodesk.com/authentication/v1/refreshtoken';
 
-    /**
-     * {@inheritdoc}
-     */
-    protected $apiDocumentation
-        = 'https://forge.autodesk.com/en/docs/oauth/v2/developers_guide/overview/';
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $apiDocumentation
+		= 'https://forge.autodesk.com/en/docs/oauth/v2/developers_guide/overview/';
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function initialize()
-    {
-        parent::initialize();
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function initialize()
+	{
+		parent::initialize();
         
-        if ($this->isRefreshTokenAvailable()) {
-            $this->tokenRefreshParameters += [
-                'client_id'     => $this->clientId,
-                'client_secret' => $this->clientSecret,
-                'grant_type'    => 'refresh_token',
-            ];
-        }
-    }
+		if ($this->isRefreshTokenAvailable()) {
+			$this->tokenRefreshParameters += [
+				'client_id'     => $this->clientId,
+				'client_secret' => $this->clientSecret,
+				'grant_type'    => 'refresh_token',
+			];
+		}
+	}
 
-    /**
-     * {@inheritdoc}
-     *
-     * See: https://forge.autodesk.com/en/docs/oauth/v2/reference/http/users-@me-GET/
-     */
-    public function getUserProfile()
-    {
-        $response = $this->apiRequest('userprofile/v1/users/@me');
+	/**
+	 * {@inheritdoc}
+	 *
+	 * See: https://forge.autodesk.com/en/docs/oauth/v2/reference/http/users-@me-GET/
+	 */
+	public function getUserProfile()
+	{
+		$response = $this->apiRequest('userprofile/v1/users/@me');
 
-        $collection = new Data\Collection($response);
+		$collection = new Data\Collection($response);
 
-        $userProfile = new User\Profile();
+		$userProfile = new User\Profile();
 
-        $userProfile->identifier = $collection->get('userId');
-        $userProfile->displayName
-            = $collection->get('firstName') .' '. $collection->get('lastName');
-        $userProfile->firstName = $collection->get('firstName');
-        $userProfile->lastName = $collection->get('lastName');
-        $userProfile->email = $collection->get('emailId');
-        $userProfile->language = $collection->get('language');
-        $userProfile->webSiteURL = $collection->get('websiteUrl');
-        $userProfile->photoURL
-            = $collection->filter('profileImages')->get('sizeX360');
+		$userProfile->identifier = $collection->get('userId');
+		$userProfile->displayName
+			= $collection->get('firstName') .' '. $collection->get('lastName');
+		$userProfile->firstName = $collection->get('firstName');
+		$userProfile->lastName = $collection->get('lastName');
+		$userProfile->email = $collection->get('emailId');
+		$userProfile->language = $collection->get('language');
+		$userProfile->webSiteURL = $collection->get('websiteUrl');
+		$userProfile->photoURL
+			= $collection->filter('profileImages')->get('sizeX360');
 
-        return $userProfile;
-    }
+		return $userProfile;
+	}
 }

src/Provider/WeChat.php

Indentation +117 added lines, -117 removed lines

@@ -17,121 +17,121 @@
  */
 class WeChat extends OAuth2
 {
-    /**
-     * {@inheritdoc}
-     */
-    protected $scope = 'snsapi_login,snsapi_userinfo,scope.userInfo';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected $apiBaseUrl = 'https://api.wechat.com/sns/';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected $authorizeUrl = 'https://open.weixin.qq.com/connect/qrconnect';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected $accessTokenUrl = 'https://api.wechat.com/sns/oauth2/access_token';
-
-    /**
-     * Refresh Token Endpoint
-     * @var string
-     */
-    protected $tokenRefreshUrl = 'https://api.wechat.com/sns/oauth2/refresh_token';
-
-    /**
-     * {@ịnheritdoc}
-     */
-    protected $accessTokenInfoUrl = 'https://api.wechat.com/sns/auth';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected $tokenExchangeMethod = 'GET';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected $tokenRefreshMethod = 'GET';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected $apiDocumentation = ''; // Not available
-
-    /**
-     * {@inheritdoc}
-     */
-    protected function initialize()
-    {
-        parent::initialize();
-
-        $this->AuthorizeUrlParameters += [
-            'appid' => $this->clientId
-        ];
-        unset($this->AuthorizeUrlParameters['client_id']);
-
-        $this->tokenExchangeParameters += [
-            'appid' => $this->clientId,
-            'secret' => $this->clientSecret
-        ];
-        unset($this->tokenExchangeParameters['client_id']);
-        unset($this->tokenExchangeParameters['client_secret']);
-
-        if ($this->isRefreshTokenAvailable()) {
-            $this->tokenRefreshParameters += [
-                'appid' => $this->clientId,
-            ];
-        }
-
-        $this->apiRequestParameters = [
-            'appid' => $this->clientId,
-            'secret' => $this->clientSecret
-        ];
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    protected function validateAccessTokenExchange($response)
-    {
-        $collection = parent::validateAccessTokenExchange($response);
-
-        $this->storeData('openid', $collection->get('openid'));
-        $this->storeData('access_token', $collection->get('access_token'));
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getUserProfile()
-    {
-        $openid = $this->getStoredData('openid');
-        $access_token = $this->getStoredData('access_token');
-
-        $response = $this->apiRequest('userinfo', 'GET', ['openid' => $openid, 'access_token' => $access_token]);
-
-        $data = new Data\Collection($response);
-
-        if (!$data->exists('openid')) {
-            throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
-        }
-
-        $userProfile = new User\Profile();
-
-        $userProfile->identifier = $data->get('openid');
-        $userProfile->displayName = $data->get('nickname');
-        $userProfile->photoURL = $data->get('headimgurl');
-        $userProfile->city = $data->get('city');
-        $userProfile->region = $data->get('province');
-        $userProfile->country = $data->get('country');
-        $genders = ['', 'male', 'female'];
-        $userProfile->gender = $genders[(int)$data->get('sex')];
-
-        return $userProfile;
-    }
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $scope = 'snsapi_login,snsapi_userinfo,scope.userInfo';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $apiBaseUrl = 'https://api.wechat.com/sns/';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $authorizeUrl = 'https://open.weixin.qq.com/connect/qrconnect';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $accessTokenUrl = 'https://api.wechat.com/sns/oauth2/access_token';
+
+	/**
+	 * Refresh Token Endpoint
+	 * @var string
+	 */
+	protected $tokenRefreshUrl = 'https://api.wechat.com/sns/oauth2/refresh_token';
+
+	/**
+	 * {@ịnheritdoc}
+	 */
+	protected $accessTokenInfoUrl = 'https://api.wechat.com/sns/auth';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $tokenExchangeMethod = 'GET';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $tokenRefreshMethod = 'GET';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $apiDocumentation = ''; // Not available
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function initialize()
+	{
+		parent::initialize();
+
+		$this->AuthorizeUrlParameters += [
+			'appid' => $this->clientId
+		];
+		unset($this->AuthorizeUrlParameters['client_id']);
+
+		$this->tokenExchangeParameters += [
+			'appid' => $this->clientId,
+			'secret' => $this->clientSecret
+		];
+		unset($this->tokenExchangeParameters['client_id']);
+		unset($this->tokenExchangeParameters['client_secret']);
+
+		if ($this->isRefreshTokenAvailable()) {
+			$this->tokenRefreshParameters += [
+				'appid' => $this->clientId,
+			];
+		}
+
+		$this->apiRequestParameters = [
+			'appid' => $this->clientId,
+			'secret' => $this->clientSecret
+		];
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function validateAccessTokenExchange($response)
+	{
+		$collection = parent::validateAccessTokenExchange($response);
+
+		$this->storeData('openid', $collection->get('openid'));
+		$this->storeData('access_token', $collection->get('access_token'));
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getUserProfile()
+	{
+		$openid = $this->getStoredData('openid');
+		$access_token = $this->getStoredData('access_token');
+
+		$response = $this->apiRequest('userinfo', 'GET', ['openid' => $openid, 'access_token' => $access_token]);
+
+		$data = new Data\Collection($response);
+
+		if (!$data->exists('openid')) {
+			throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
+		}
+
+		$userProfile = new User\Profile();
+
+		$userProfile->identifier = $data->get('openid');
+		$userProfile->displayName = $data->get('nickname');
+		$userProfile->photoURL = $data->get('headimgurl');
+		$userProfile->city = $data->get('city');
+		$userProfile->region = $data->get('province');
+		$userProfile->country = $data->get('country');
+		$genders = ['', 'male', 'female'];
+		$userProfile->gender = $genders[(int)$data->get('sex')];
+
+		return $userProfile;
+	}
 }

src/Provider/Twitter.php

Indentation +221 added lines, -221 removed lines

@@ -40,225 +40,225 @@
  */
 class Twitter extends OAuth1
 {
-    /**
-     * {@inheritdoc}
-     */
-    protected $apiBaseUrl = 'https://api.twitter.com/1.1/';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected $authorizeUrl = 'https://api.twitter.com/oauth/authenticate';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected $requestTokenUrl = 'https://api.twitter.com/oauth/request_token';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected $accessTokenUrl = 'https://api.twitter.com/oauth/access_token';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected $apiDocumentation = 'https://dev.twitter.com/web/sign-in/implementing';
-
-    /**
-     * {@inheritdoc}
-     */
-    protected function getAuthorizeUrl($parameters = [])
-    {
-        if ($this->config->get('authorize') === true) {
-            $this->authorizeUrl = 'https://api.twitter.com/oauth/authorize';
-        }
-
-        return parent::getAuthorizeUrl($parameters);
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getUserProfile()
-    {
-        $response = $this->apiRequest('account/verify_credentials.json', 'GET', [
-            'include_email' => $this->config->get('include_email') === false ? 'false' : 'true',
-        ]);
-
-        $data = new Data\Collection($response);
-
-        if (!$data->exists('id_str')) {
-            throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
-        }
-
-        $userProfile = new User\Profile();
-
-        $userProfile->identifier = $data->get('id_str');
-        $userProfile->displayName = $data->get('screen_name');
-        $userProfile->description = $data->get('description');
-        $userProfile->firstName = $data->get('name');
-        $userProfile->email = $data->get('email');
-        $userProfile->emailVerified = $data->get('email');
-        $userProfile->webSiteURL = $data->get('url');
-        $userProfile->region = $data->get('location');
-
-        $userProfile->profileURL = $data->exists('screen_name')
-            ? ('https://twitter.com/' . $data->get('screen_name'))
-            : '';
-
-        $photoSize = $this->config->get('photo_size') ?: 'original';
-        $photoSize = $photoSize === 'original' ? '' : "_{$photoSize}";
-        $userProfile->photoURL = $data->exists('profile_image_url_https')
-            ? str_replace('_normal', $photoSize, $data->get('profile_image_url_https'))
-            : '';
-
-        $userProfile->data = [
-            'followed_by' => $data->get('followers_count'),
-            'follows' => $data->get('friends_count'),
-        ];
-
-        return $userProfile;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getUserContacts($parameters = [])
-    {
-        $parameters = ['cursor' => '-1'] + $parameters;
-
-        $response = $this->apiRequest('friends/ids.json', 'GET', $parameters);
-
-        $data = new Data\Collection($response);
-
-        if (!$data->exists('ids')) {
-            throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
-        }
-
-        if ($data->filter('ids')->isEmpty()) {
-            return [];
-        }
-
-        $contacts = [];
-
-        // 75 id per time should be okey
-        $contactsIds = array_chunk((array)$data->get('ids'), 75);
-
-        foreach ($contactsIds as $chunk) {
-            $parameters = ['user_id' => implode(',', $chunk)];
-
-            try {
-                $response = $this->apiRequest('users/lookup.json', 'GET', $parameters);
-
-                if ($response && count($response)) {
-                    foreach ($response as $item) {
-                        $contacts[] = $this->fetchUserContact($item);
-                    }
-                }
-            } catch (\Exception $e) {
-                continue;
-            }
-        }
-
-        return $contacts;
-    }
-
-    /**
-     * @param $item
-     *
-     * @return User\Contact
-     */
-    protected function fetchUserContact($item)
-    {
-        $item = new Data\Collection($item);
-
-        $userContact = new User\Contact();
-
-        $userContact->identifier = $item->get('id_str');
-        $userContact->displayName = $item->get('name');
-        $userContact->photoURL = $item->get('profile_image_url');
-        $userContact->description = $item->get('description');
-
-        $userContact->profileURL = $item->exists('screen_name')
-            ? ('https://twitter.com/' . $item->get('screen_name'))
-            : '';
-
-        return $userContact;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function setUserStatus($status)
-    {
-        if (is_string($status)) {
-            $status = ['status' => $status];
-        }
-
-        // Prepare request parameters.
-        $params = [];
-        if (isset($status['status'])) {
-            $params['status'] = $status['status'];
-        }
-        if (isset($status['picture'])) {
-            $media = $this->apiRequest('https://upload.twitter.com/1.1/media/upload.json', 'POST', [
-                'media' => base64_encode(file_get_contents($status['picture'])),
-            ]);
-            $params['media_ids'] = $media->media_id;
-        }
-
-        $response = $this->apiRequest('statuses/update.json', 'POST', $params);
-
-        return $response;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getUserActivity($stream = 'me')
-    {
-        $apiUrl = ($stream == 'me')
-            ? 'statuses/user_timeline.json'
-            : 'statuses/home_timeline.json';
-
-        $response = $this->apiRequest($apiUrl);
-
-        if (!$response) {
-            return [];
-        }
-
-        $activities = [];
-
-        foreach ($response as $item) {
-            $activities[] = $this->fetchUserActivity($item);
-        }
-
-        return $activities;
-    }
-
-    /**
-     * @param $item
-     * @return User\Activity
-     */
-    protected function fetchUserActivity($item)
-    {
-        $item = new Data\Collection($item);
-
-        $userActivity = new User\Activity();
-
-        $userActivity->id = $item->get('id_str');
-        $userActivity->date = $item->get('created_at');
-        $userActivity->text = $item->get('text');
-
-        $userActivity->user->identifier = $item->filter('user')->get('id_str');
-        $userActivity->user->displayName = $item->filter('user')->get('name');
-        $userActivity->user->photoURL = $item->filter('user')->get('profile_image_url');
-
-        $userActivity->user->profileURL = $item->filter('user')->get('screen_name')
-            ? ('https://twitter.com/' . $item->filter('user')->get('screen_name'))
-            : '';
-
-        return $userActivity;
-    }
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $apiBaseUrl = 'https://api.twitter.com/1.1/';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $authorizeUrl = 'https://api.twitter.com/oauth/authenticate';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $requestTokenUrl = 'https://api.twitter.com/oauth/request_token';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $accessTokenUrl = 'https://api.twitter.com/oauth/access_token';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $apiDocumentation = 'https://dev.twitter.com/web/sign-in/implementing';
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function getAuthorizeUrl($parameters = [])
+	{
+		if ($this->config->get('authorize') === true) {
+			$this->authorizeUrl = 'https://api.twitter.com/oauth/authorize';
+		}
+
+		return parent::getAuthorizeUrl($parameters);
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getUserProfile()
+	{
+		$response = $this->apiRequest('account/verify_credentials.json', 'GET', [
+			'include_email' => $this->config->get('include_email') === false ? 'false' : 'true',
+		]);
+
+		$data = new Data\Collection($response);
+
+		if (!$data->exists('id_str')) {
+			throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
+		}
+
+		$userProfile = new User\Profile();
+
+		$userProfile->identifier = $data->get('id_str');
+		$userProfile->displayName = $data->get('screen_name');
+		$userProfile->description = $data->get('description');
+		$userProfile->firstName = $data->get('name');
+		$userProfile->email = $data->get('email');
+		$userProfile->emailVerified = $data->get('email');
+		$userProfile->webSiteURL = $data->get('url');
+		$userProfile->region = $data->get('location');
+
+		$userProfile->profileURL = $data->exists('screen_name')
+			? ('https://twitter.com/' . $data->get('screen_name'))
+			: '';
+
+		$photoSize = $this->config->get('photo_size') ?: 'original';
+		$photoSize = $photoSize === 'original' ? '' : "_{$photoSize}";
+		$userProfile->photoURL = $data->exists('profile_image_url_https')
+			? str_replace('_normal', $photoSize, $data->get('profile_image_url_https'))
+			: '';
+
+		$userProfile->data = [
+			'followed_by' => $data->get('followers_count'),
+			'follows' => $data->get('friends_count'),
+		];
+
+		return $userProfile;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getUserContacts($parameters = [])
+	{
+		$parameters = ['cursor' => '-1'] + $parameters;
+
+		$response = $this->apiRequest('friends/ids.json', 'GET', $parameters);
+
+		$data = new Data\Collection($response);
+
+		if (!$data->exists('ids')) {
+			throw new UnexpectedApiResponseException('Provider API returned an unexpected response.');
+		}
+
+		if ($data->filter('ids')->isEmpty()) {
+			return [];
+		}
+
+		$contacts = [];
+
+		// 75 id per time should be okey
+		$contactsIds = array_chunk((array)$data->get('ids'), 75);
+
+		foreach ($contactsIds as $chunk) {
+			$parameters = ['user_id' => implode(',', $chunk)];
+
+			try {
+				$response = $this->apiRequest('users/lookup.json', 'GET', $parameters);
+
+				if ($response && count($response)) {
+					foreach ($response as $item) {
+						$contacts[] = $this->fetchUserContact($item);
+					}
+				}
+			} catch (\Exception $e) {
+				continue;
+			}
+		}
+
+		return $contacts;
+	}
+
+	/**
+	 * @param $item
+	 *
+	 * @return User\Contact
+	 */
+	protected function fetchUserContact($item)
+	{
+		$item = new Data\Collection($item);
+
+		$userContact = new User\Contact();
+
+		$userContact->identifier = $item->get('id_str');
+		$userContact->displayName = $item->get('name');
+		$userContact->photoURL = $item->get('profile_image_url');
+		$userContact->description = $item->get('description');
+
+		$userContact->profileURL = $item->exists('screen_name')
+			? ('https://twitter.com/' . $item->get('screen_name'))
+			: '';
+
+		return $userContact;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function setUserStatus($status)
+	{
+		if (is_string($status)) {
+			$status = ['status' => $status];
+		}
+
+		// Prepare request parameters.
+		$params = [];
+		if (isset($status['status'])) {
+			$params['status'] = $status['status'];
+		}
+		if (isset($status['picture'])) {
+			$media = $this->apiRequest('https://upload.twitter.com/1.1/media/upload.json', 'POST', [
+				'media' => base64_encode(file_get_contents($status['picture'])),
+			]);
+			$params['media_ids'] = $media->media_id;
+		}
+
+		$response = $this->apiRequest('statuses/update.json', 'POST', $params);
+
+		return $response;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getUserActivity($stream = 'me')
+	{
+		$apiUrl = ($stream == 'me')
+			? 'statuses/user_timeline.json'
+			: 'statuses/home_timeline.json';
+
+		$response = $this->apiRequest($apiUrl);
+
+		if (!$response) {
+			return [];
+		}
+
+		$activities = [];
+
+		foreach ($response as $item) {
+			$activities[] = $this->fetchUserActivity($item);
+		}
+
+		return $activities;
+	}
+
+	/**
+	 * @param $item
+	 * @return User\Activity
+	 */
+	protected function fetchUserActivity($item)
+	{
+		$item = new Data\Collection($item);
+
+		$userActivity = new User\Activity();
+
+		$userActivity->id = $item->get('id_str');
+		$userActivity->date = $item->get('created_at');
+		$userActivity->text = $item->get('text');
+
+		$userActivity->user->identifier = $item->filter('user')->get('id_str');
+		$userActivity->user->displayName = $item->filter('user')->get('name');
+		$userActivity->user->photoURL = $item->filter('user')->get('profile_image_url');
+
+		$userActivity->user->profileURL = $item->filter('user')->get('screen_name')
+			? ('https://twitter.com/' . $item->filter('user')->get('screen_name'))
+			: '';
+
+		return $userActivity;
+	}
 }