hybridauth / hybridauth

src/User/Activity.php

Indentation +50 added lines, -50 removed lines

@@ -14,60 +14,60 @@
  */
 final class Activity
 {
-    /**
-     * activity id on the provider side, usually given as integer
-     *
-     * @var string
-     */
-    public $id = null;
+	/**
+	 * activity id on the provider side, usually given as integer
+	 *
+	 * @var string
+	 */
+	public $id = null;
 
-    /**
-     * activity date of creation
-     *
-     * @var string
-     */
-    public $date = null;
+	/**
+	 * activity date of creation
+	 *
+	 * @var string
+	 */
+	public $date = null;
 
-    /**
-     * activity content as a string
-     *
-     * @var string
-     */
-    public $text = null;
+	/**
+	 * activity content as a string
+	 *
+	 * @var string
+	 */
+	public $text = null;
 
-    /**
-     * user who created the activity
-     *
-     * @var object
-     */
-    public $user = null;
+	/**
+	 * user who created the activity
+	 *
+	 * @var object
+	 */
+	public $user = null;
 
-    /**
-     *
-     */
-    public function __construct()
-    {
-        $this->user = new \stdClass();
+	/**
+	 *
+	 */
+	public function __construct()
+	{
+		$this->user = new \stdClass();
 
-        // typically, we should have a few information about the user who created the event from social apis
-        $this->user->identifier = null;
-        $this->user->displayName = null;
-        $this->user->profileURL = null;
-        $this->user->photoURL = null;
-    }
+		// typically, we should have a few information about the user who created the event from social apis
+		$this->user->identifier = null;
+		$this->user->displayName = null;
+		$this->user->profileURL = null;
+		$this->user->photoURL = null;
+	}
 
-    /**
-     * Prevent the providers adapters from adding new fields.
-     *
-     * @throws UnexpectedValueException
-     * @var string $name
-     *
-     * @var mixed $value
-     *
-     */
-    public function __set($name, $value)
-    {
-        // phpcs:ignore
-        throw new UnexpectedValueException(sprintf('Adding new property "%s\' to %s is not allowed.', $name, __CLASS__));
-    }
+	/**
+	 * Prevent the providers adapters from adding new fields.
+	 *
+	 * @throws UnexpectedValueException
+	 * @var string $name
+	 *
+	 * @var mixed $value
+	 *
+	 */
+	public function __set($name, $value)
+	{
+		// phpcs:ignore
+		throw new UnexpectedValueException(sprintf('Adding new property "%s\' to %s is not allowed.', $name, __CLASS__));
+	}
 }

src/User/Contact.php

Indentation +54 added lines, -54 removed lines

@@ -14,65 +14,65 @@
  */
 final class Contact
 {
-    /**
-     * The Unique contact user ID
-     *
-     * @var string
-     */
-    public $identifier = null;
+	/**
+	 * The Unique contact user ID
+	 *
+	 * @var string
+	 */
+	public $identifier = null;
 
-    /**
-     * User website, blog, web page
-     *
-     * @var string
-     */
-    public $webSiteURL = null;
+	/**
+	 * User website, blog, web page
+	 *
+	 * @var string
+	 */
+	public $webSiteURL = null;
 
-    /**
-     * URL link to profile page on the IDp web site
-     *
-     * @var string
-     */
-    public $profileURL = null;
+	/**
+	 * URL link to profile page on the IDp web site
+	 *
+	 * @var string
+	 */
+	public $profileURL = null;
 
-    /**
-     * URL link to user photo or avatar
-     *
-     * @var string
-     */
-    public $photoURL = null;
+	/**
+	 * URL link to user photo or avatar
+	 *
+	 * @var string
+	 */
+	public $photoURL = null;
 
-    /**
-     * User displayName provided by the IDp or a concatenation of first and last name
-     *
-     * @var string
-     */
-    public $displayName = null;
+	/**
+	 * User displayName provided by the IDp or a concatenation of first and last name
+	 *
+	 * @var string
+	 */
+	public $displayName = null;
 
-    /**
-     * A short about_me
-     *
-     * @var string
-     */
-    public $description = null;
+	/**
+	 * A short about_me
+	 *
+	 * @var string
+	 */
+	public $description = null;
 
-    /**
-     * User email. Not all of IDp grant access to the user email
-     *
-     * @var string
-     */
-    public $email = null;
+	/**
+	 * User email. Not all of IDp grant access to the user email
+	 *
+	 * @var string
+	 */
+	public $email = null;
 
-    /**
-     * Prevent the providers adapters from adding new fields.
-     *
-     * @param string $name
-     * @param mixed $value
-     *
-     * @throws UnexpectedValueException
-     */
-    public function __set($name, $value)
-    {
-        throw new UnexpectedValueException(sprintf('Adding new property "%s" to %s is not allowed.', $name, __CLASS__));
-    }
+	/**
+	 * Prevent the providers adapters from adding new fields.
+	 *
+	 * @param string $name
+	 * @param mixed $value
+	 *
+	 * @throws UnexpectedValueException
+	 */
+	public function __set($name, $value)
+	{
+		throw new UnexpectedValueException(sprintf('Adding new property "%s" to %s is not allowed.', $name, __CLASS__));
+	}
 }

src/Storage/Session.php

Indentation +113 added lines, -113 removed lines

@@ -14,117 +14,117 @@
  */
 class Session implements StorageInterface
 {
-    /**
-     * Namespace
-     *
-     * @var string
-     */
-    protected $storeNamespace = 'HYBRIDAUTH::STORAGE';
-
-    /**
-     * Key prefix
-     *
-     * @var string
-     */
-    protected $keyPrefix = '';
-
-    /**
-     * Initiate a new session
-     *
-     * @throws RuntimeException
-     */
-    public function __construct()
-    {
-        if (session_id()) {
-            return;
-        }
-
-        if (headers_sent()) {
-            // phpcs:ignore
-            throw new RuntimeException('HTTP headers already sent to browser and Hybridauth won\'t be able to start/resume PHP session. To resolve this, session_start() must be called before outputing any data.');
-        }
-
-        if (!session_start()) {
-            throw new RuntimeException('PHP session failed to start.');
-        }
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function get($key)
-    {
-        $key = $this->keyPrefix . strtolower($key);
-
-        if (isset($_SESSION[$this->storeNamespace], $_SESSION[$this->storeNamespace][$key])) {
-            $value = $_SESSION[$this->storeNamespace][$key];
-
-            if (is_array($value) && array_key_exists('lateObject', $value)) {
-                $value = unserialize($value['lateObject']);
-            }
-
-            return $value;
-        }
-
-        return null;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function set($key, $value)
-    {
-        $key = $this->keyPrefix . strtolower($key);
-
-        if (is_object($value)) {
-            // We encapsulate as our classes may be defined after session is initialized.
-            $value = ['lateObject' => serialize($value)];
-        }
-
-        $_SESSION[$this->storeNamespace][$key] = $value;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function clear()
-    {
-        $_SESSION[$this->storeNamespace] = [];
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function delete($key)
-    {
-        $key = $this->keyPrefix . strtolower($key);
-
-        if (isset($_SESSION[$this->storeNamespace], $_SESSION[$this->storeNamespace][$key])) {
-            $tmp = $_SESSION[$this->storeNamespace];
-
-            unset($tmp[$key]);
-
-            $_SESSION[$this->storeNamespace] = $tmp;
-        }
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function deleteMatch($key)
-    {
-        $key = $this->keyPrefix . strtolower($key);
-
-        if (isset($_SESSION[$this->storeNamespace]) && count($_SESSION[$this->storeNamespace])) {
-            $tmp = $_SESSION[$this->storeNamespace];
-
-            foreach ($tmp as $k => $v) {
-                if (strstr($k, $key)) {
-                    unset($tmp[$k]);
-                }
-            }
-
-            $_SESSION[$this->storeNamespace] = $tmp;
-        }
-    }
+	/**
+	 * Namespace
+	 *
+	 * @var string
+	 */
+	protected $storeNamespace = 'HYBRIDAUTH::STORAGE';
+
+	/**
+	 * Key prefix
+	 *
+	 * @var string
+	 */
+	protected $keyPrefix = '';
+
+	/**
+	 * Initiate a new session
+	 *
+	 * @throws RuntimeException
+	 */
+	public function __construct()
+	{
+		if (session_id()) {
+			return;
+		}
+
+		if (headers_sent()) {
+			// phpcs:ignore
+			throw new RuntimeException('HTTP headers already sent to browser and Hybridauth won\'t be able to start/resume PHP session. To resolve this, session_start() must be called before outputing any data.');
+		}
+
+		if (!session_start()) {
+			throw new RuntimeException('PHP session failed to start.');
+		}
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function get($key)
+	{
+		$key = $this->keyPrefix . strtolower($key);
+
+		if (isset($_SESSION[$this->storeNamespace], $_SESSION[$this->storeNamespace][$key])) {
+			$value = $_SESSION[$this->storeNamespace][$key];
+
+			if (is_array($value) && array_key_exists('lateObject', $value)) {
+				$value = unserialize($value['lateObject']);
+			}
+
+			return $value;
+		}
+
+		return null;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function set($key, $value)
+	{
+		$key = $this->keyPrefix . strtolower($key);
+
+		if (is_object($value)) {
+			// We encapsulate as our classes may be defined after session is initialized.
+			$value = ['lateObject' => serialize($value)];
+		}
+
+		$_SESSION[$this->storeNamespace][$key] = $value;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function clear()
+	{
+		$_SESSION[$this->storeNamespace] = [];
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function delete($key)
+	{
+		$key = $this->keyPrefix . strtolower($key);
+
+		if (isset($_SESSION[$this->storeNamespace], $_SESSION[$this->storeNamespace][$key])) {
+			$tmp = $_SESSION[$this->storeNamespace];
+
+			unset($tmp[$key]);
+
+			$_SESSION[$this->storeNamespace] = $tmp;
+		}
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function deleteMatch($key)
+	{
+		$key = $this->keyPrefix . strtolower($key);
+
+		if (isset($_SESSION[$this->storeNamespace]) && count($_SESSION[$this->storeNamespace])) {
+			$tmp = $_SESSION[$this->storeNamespace];
+
+			foreach ($tmp as $k => $v) {
+				if (strstr($k, $key)) {
+					unset($tmp[$k]);
+				}
+			}
+
+			$_SESSION[$this->storeNamespace] = $tmp;
+		}
+	}
 }

src/Provider/Medium.php

Indentation +56 added lines, -56 removed lines

@@ -17,72 +17,72 @@
  */
 class Medium extends OAuth2
 {
-    /**
-     * {@inheritdoc}
-     */
-    protected $scope = 'basicProfile';
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $scope = 'basicProfile';
 
-    /**
-     * {@inheritdoc}
-     */
-    protected $apiBaseUrl = 'https://api.medium.com/v1/';
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $apiBaseUrl = 'https://api.medium.com/v1/';
 
-    /**
-     * {@inheritdoc}
-     */
-    protected $authorizeUrl = 'https://medium.com/m/oauth/authorize';
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $authorizeUrl = 'https://medium.com/m/oauth/authorize';
 
-    /**
-     * {@inheritdoc}
-     */
-    protected $accessTokenUrl = 'https://api.medium.com/v1/tokens';
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $accessTokenUrl = 'https://api.medium.com/v1/tokens';
 
-    /**
-     * {@inheritdoc}
-     */
-    protected $apiDocumentation = 'https://github.com/Medium/medium-api-docs';
+	/**
+	 * {@inheritdoc}
+	 */
+	protected $apiDocumentation = 'https://github.com/Medium/medium-api-docs';
 
-    /**
-     * {@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,
-            ];
-        }
-    }
+		if ($this->isRefreshTokenAvailable()) {
+			$this->tokenRefreshParameters += [
+				'client_id' => $this->clientId,
+				'client_secret' => $this->clientSecret,
+			];
+		}
+	}
 
-    /**
-     * {@inheritdoc}
-     *
-     * See: https://github.com/Medium/medium-api-docs#getting-the-authenticated-users-details
-     */
-    public function getUserProfile()
-    {
-        $response = $this->apiRequest('me');
+	/**
+	 * {@inheritdoc}
+	 *
+	 * See: https://github.com/Medium/medium-api-docs#getting-the-authenticated-users-details
+	 */
+	public function getUserProfile()
+	{
+		$response = $this->apiRequest('me');
 
-        $data = new Data\Collection($response);
+		$data = new Data\Collection($response);
 
-        $userProfile = new User\Profile();
-        $data = $data->filter('data');
+		$userProfile = new User\Profile();
+		$data = $data->filter('data');
 
-        $full_name = explode(' ', $data->get('name'));
-        if (count($full_name) < 2) {
-            $full_name[1] = '';
-        }
+		$full_name = explode(' ', $data->get('name'));
+		if (count($full_name) < 2) {
+			$full_name[1] = '';
+		}
 
-        $userProfile->identifier = $data->get('id');
-        $userProfile->displayName = $data->get('username');
-        $userProfile->profileURL = $data->get('imageUrl');
-        $userProfile->firstName = $full_name[0];
-        $userProfile->lastName = $full_name[1];
-        $userProfile->profileURL = $data->get('url');
+		$userProfile->identifier = $data->get('id');
+		$userProfile->displayName = $data->get('username');
+		$userProfile->profileURL = $data->get('imageUrl');
+		$userProfile->firstName = $full_name[0];
+		$userProfile->lastName = $full_name[1];
+		$userProfile->profileURL = $data->get('url');
 
-        return $userProfile;
-    }
+		return $userProfile;
+	}
 }

src/Adapter/AdapterInterface.php

Indentation +136 added lines, -136 removed lines

@@ -16,140 +16,140 @@
  */
 interface AdapterInterface
 {
-    /**
-     * Initiate the appropriate protocol and process/automate the authentication or authorization flow.
-     *
-     * @return bool|null
-     */
-    public function authenticate();
-
-    /**
-     * Returns TRUE if the user is connected
-     *
-     * @return bool
-     */
-    public function isConnected();
-
-    /**
-     * Clear all access token in storage
-     */
-    public function disconnect();
-
-    /**
-     * Retrieve the connected user profile
-     *
-     * @return \Hybridauth\User\Profile
-     */
-    public function getUserProfile();
-
-    /**
-     * Retrieve the connected user contacts list
-     *
-     * @return \Hybridauth\User\Contact[]
-     */
-    public function getUserContacts();
-
-    /**
-     * Retrieve the connected user pages|companies|groups list
-     *
-     * @return array
-     */
-    public function getUserPages();
-
-    /**
-     * Retrieve the user activity stream
-     *
-     * @param string $stream
-     *
-     * @return \Hybridauth\User\Activity[]
-     */
-    public function getUserActivity($stream);
-
-    /**
-     * Post a status on user wall|timeline|blog|website|etc.
-     *
-     * @param string|array $status
-     *
-     * @return mixed API response
-     */
-    public function setUserStatus($status);
-
-    /**
-     * Post a status on page|company|group wall.
-     *
-     * @param string|array $status
-     * @param string $pageId
-     *
-     * @return mixed API response
-     */
-    public function setPageStatus($status, $pageId);
-
-    /**
-     * Send a signed request to provider API
-     *
-     * @param string $url
-     * @param string $method
-     * @param array $parameters
-     * @param array $headers
-     * @param bool $multipart
-     *
-     * @return mixed
-     */
-    public function apiRequest($url, $method = 'GET', $parameters = [], $headers = [], $multipart = false);
-
-    /**
-     * Do whatever may be necessary to make sure tokens do not expire.
-     * Intended to be be called frequently, e.g. via Cron.
-     */
-    public function maintainToken();
-
-    /**
-     * Return oauth access tokens.
-     *
-     * @return array
-     */
-    public function getAccessToken();
-
-    /**
-     * Set oauth access tokens.
-     *
-     * @param array $tokens
-     */
-    public function setAccessToken($tokens = []);
-
-    /**
-     * Set http client instance.
-     *
-     * @param HttpClientInterface $httpClient
-     */
-    public function setHttpClient(HttpClientInterface $httpClient = null);
-
-    /**
-     * Return http client instance.
-     */
-    public function getHttpClient();
-
-    /**
-     * Set storage instance.
-     *
-     * @param StorageInterface $storage
-     */
-    public function setStorage(StorageInterface $storage = null);
-
-    /**
-     * Return storage instance.
-     */
-    public function getStorage();
-
-    /**
-     * Set Logger instance.
-     *
-     * @param LoggerInterface $logger
-     */
-    public function setLogger(LoggerInterface $logger = null);
-
-    /**
-     * Return logger instance.
-     */
-    public function getLogger();
+	/**
+	 * Initiate the appropriate protocol and process/automate the authentication or authorization flow.
+	 *
+	 * @return bool|null
+	 */
+	public function authenticate();
+
+	/**
+	 * Returns TRUE if the user is connected
+	 *
+	 * @return bool
+	 */
+	public function isConnected();
+
+	/**
+	 * Clear all access token in storage
+	 */
+	public function disconnect();
+
+	/**
+	 * Retrieve the connected user profile
+	 *
+	 * @return \Hybridauth\User\Profile
+	 */
+	public function getUserProfile();
+
+	/**
+	 * Retrieve the connected user contacts list
+	 *
+	 * @return \Hybridauth\User\Contact[]
+	 */
+	public function getUserContacts();
+
+	/**
+	 * Retrieve the connected user pages|companies|groups list
+	 *
+	 * @return array
+	 */
+	public function getUserPages();
+
+	/**
+	 * Retrieve the user activity stream
+	 *
+	 * @param string $stream
+	 *
+	 * @return \Hybridauth\User\Activity[]
+	 */
+	public function getUserActivity($stream);
+
+	/**
+	 * Post a status on user wall|timeline|blog|website|etc.
+	 *
+	 * @param string|array $status
+	 *
+	 * @return mixed API response
+	 */
+	public function setUserStatus($status);
+
+	/**
+	 * Post a status on page|company|group wall.
+	 *
+	 * @param string|array $status
+	 * @param string $pageId
+	 *
+	 * @return mixed API response
+	 */
+	public function setPageStatus($status, $pageId);
+
+	/**
+	 * Send a signed request to provider API
+	 *
+	 * @param string $url
+	 * @param string $method
+	 * @param array $parameters
+	 * @param array $headers
+	 * @param bool $multipart
+	 *
+	 * @return mixed
+	 */
+	public function apiRequest($url, $method = 'GET', $parameters = [], $headers = [], $multipart = false);
+
+	/**
+	 * Do whatever may be necessary to make sure tokens do not expire.
+	 * Intended to be be called frequently, e.g. via Cron.
+	 */
+	public function maintainToken();
+
+	/**
+	 * Return oauth access tokens.
+	 *
+	 * @return array
+	 */
+	public function getAccessToken();
+
+	/**
+	 * Set oauth access tokens.
+	 *
+	 * @param array $tokens
+	 */
+	public function setAccessToken($tokens = []);
+
+	/**
+	 * Set http client instance.
+	 *
+	 * @param HttpClientInterface $httpClient
+	 */
+	public function setHttpClient(HttpClientInterface $httpClient = null);
+
+	/**
+	 * Return http client instance.
+	 */
+	public function getHttpClient();
+
+	/**
+	 * Set storage instance.
+	 *
+	 * @param StorageInterface $storage
+	 */
+	public function setStorage(StorageInterface $storage = null);
+
+	/**
+	 * Return storage instance.
+	 */
+	public function getStorage();
+
+	/**
+	 * Set Logger instance.
+	 *
+	 * @param LoggerInterface $logger
+	 */
+	public function setLogger(LoggerInterface $logger = null);
+
+	/**
+	 * Return logger instance.
+	 */
+	public function getLogger();
 }

src/Adapter/AbstractAdapter.php

Indentation +345 added lines, -345 removed lines

@@ -24,349 +24,349 @@
  */
 abstract class AbstractAdapter implements AdapterInterface
 {
-    use DataStoreTrait;
-
-    /**
-     * Provider ID (unique name).
-     *
-     * @var string
-     */
-    protected $providerId = '';
-
-    /**
-     * Specific Provider config.
-     *
-     * @var mixed
-     */
-    protected $config = [];
-
-    /**
-     * Extra Provider parameters.
-     *
-     * @var array
-     */
-    protected $params;
-
-    /**
-     * Callback url
-     *
-     * @var string
-     */
-    protected $callback = '';
-
-    /**
-     * Storage.
-     *
-     * @var StorageInterface
-     */
-    public $storage;
-
-    /**
-     * HttpClient.
-     *
-     * @var HttpClientInterface
-     */
-    public $httpClient;
-
-    /**
-     * Logger.
-     *
-     * @var LoggerInterface
-     */
-    public $logger;
-
-    /**
-     * Whether to validate API status codes of http responses
-     *
-     * @var bool
-     */
-    protected $validateApiResponseHttpCode = true;
-
-    /**
-     * Common adapters constructor.
-     *
-     * @param array $config
-     * @param HttpClientInterface $httpClient
-     * @param StorageInterface $storage
-     * @param LoggerInterface $logger
-     */
-    public function __construct(
-        $config = [],
-        HttpClientInterface $httpClient = null,
-        StorageInterface $storage = null,
-        LoggerInterface $logger = null
-    ) {
-        $this->providerId = (new \ReflectionClass($this))->getShortName();
-
-        $this->config = new Data\Collection($config);
-
-        $this->setHttpClient($httpClient);
-
-        $this->setStorage($storage);
-
-        $this->setLogger($logger);
-
-        $this->configure();
-
-        $this->logger->debug(sprintf('Initialize %s, config: ', get_class($this)), $config);
-
-        $this->initialize();
-    }
-
-    /**
-     * Load adapter's configuration
-     */
-    abstract protected function configure();
-
-    /**
-     * Adapter initializer
-     */
-    abstract protected function initialize();
-
-    /**
-     * {@inheritdoc}
-     */
-    abstract public function isConnected();
-
-    /**
-     * {@inheritdoc}
-     */
-    public function apiRequest($url, $method = 'GET', $parameters = [], $headers = [], $multipart = false)
-    {
-        throw new NotImplementedException('Provider does not support this feature.');
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function maintainToken()
-    {
-        // Nothing needed for most providers
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getUserProfile()
-    {
-        throw new NotImplementedException('Provider does not support this feature.');
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getUserContacts()
-    {
-        throw new NotImplementedException('Provider does not support this feature.');
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getUserPages()
-    {
-        throw new NotImplementedException('Provider does not support this feature.');
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getUserActivity($stream)
-    {
-        throw new NotImplementedException('Provider does not support this feature.');
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function setUserStatus($status)
-    {
-        throw new NotImplementedException('Provider does not support this feature.');
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function setPageStatus($status, $pageId)
-    {
-        throw new NotImplementedException('Provider does not support this feature.');
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function disconnect()
-    {
-        $this->clearStoredData();
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getAccessToken()
-    {
-        $tokenNames = [
-            'access_token',
-            'access_token_secret',
-            'token_type',
-            'refresh_token',
-            'expires_in',
-            'expires_at',
-        ];
-
-        $tokens = [];
-
-        foreach ($tokenNames as $name) {
-            if ($this->getStoredData($name)) {
-                $tokens[$name] = $this->getStoredData($name);
-            }
-        }
-
-        return $tokens;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function setAccessToken($tokens = [])
-    {
-        $this->clearStoredData();
-
-        foreach ($tokens as $token => $value) {
-            $this->storeData($token, $value);
-        }
-
-        // Re-initialize token parameters.
-        $this->initialize();
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function setHttpClient(HttpClientInterface $httpClient = null)
-    {
-        $this->httpClient = $httpClient ?: new HttpClient();
-
-        if ($this->config->exists('curl_options') && method_exists($this->httpClient, 'setCurlOptions')) {
-            $this->httpClient->setCurlOptions($this->config->get('curl_options'));
-        }
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getHttpClient()
-    {
-        return $this->httpClient;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function setStorage(StorageInterface $storage = null)
-    {
-        $this->storage = $storage ?: new Session();
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getStorage()
-    {
-        return $this->storage;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function setLogger(LoggerInterface $logger = null)
-    {
-        $this->logger = $logger ?: new Logger(
-            $this->config->get('debug_mode'),
-            $this->config->get('debug_file')
-        );
-
-        if (method_exists($this->httpClient, 'setLogger')) {
-            $this->httpClient->setLogger($this->logger);
-        }
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getLogger()
-    {
-        return $this->logger;
-    }
-
-    /**
-     * Set Adapter's API callback url
-     *
-     * @param string $callback
-     *
-     * @throws InvalidArgumentException
-     */
-    protected function setCallback($callback)
-    {
-        if (!filter_var($callback, FILTER_VALIDATE_URL)) {
-            throw new InvalidArgumentException('A valid callback url is required.');
-        }
-
-        $this->callback = $callback;
-    }
-
-    /**
-     * Overwrite Adapter's API endpoints
-     *
-     * @param array|Data\Collection $endpoints
-     */
-    protected function setApiEndpoints($endpoints = null)
-    {
-        if (empty($endpoints)) {
-            return;
-        }
-
-        $collection = is_array($endpoints) ? new Data\Collection($endpoints) : $endpoints;
-
-        $this->apiBaseUrl = $collection->get('api_base_url') ?: $this->apiBaseUrl;
-        $this->authorizeUrl = $collection->get('authorize_url') ?: $this->authorizeUrl;
-        $this->accessTokenUrl = $collection->get('access_token_url') ?: $this->accessTokenUrl;
-    }
-
-
-    /**
-     * Validate signed API responses Http status code.
-     *
-     * Since the specifics of error responses is beyond the scope of RFC6749 and OAuth Core specifications,
-     * Hybridauth will consider any HTTP status code that is different than '200 OK' as an ERROR.
-     *
-     * @param string $error String to pre append to message thrown in exception
-     *
-     * @throws HttpClientFailureException
-     * @throws HttpRequestFailedException
-     */
-    protected function validateApiResponse($error = '')
-    {
-        $error .= !empty($error) ? '. ' : '';
-
-        if ($this->httpClient->getResponseClientError()) {
-            throw new HttpClientFailureException(
-                $error . 'HTTP client error: ' . $this->httpClient->getResponseClientError() . '.'
-            );
-        }
-
-        // if validateApiResponseHttpCode is set to false, we by pass verification of http status code
-        if (!$this->validateApiResponseHttpCode) {
-            return;
-        }
-
-        $status = $this->httpClient->getResponseHttpCode();
-
-        if ($status < 200 || $status > 299) {
-            throw new HttpRequestFailedException(
-                $error . 'HTTP error ' . $this->httpClient->getResponseHttpCode() .
-                '. Raw Provider API response: ' . $this->httpClient->getResponseBody() . '.'
-            );
-        }
-    }
+	use DataStoreTrait;
+
+	/**
+	 * Provider ID (unique name).
+	 *
+	 * @var string
+	 */
+	protected $providerId = '';
+
+	/**
+	 * Specific Provider config.
+	 *
+	 * @var mixed
+	 */
+	protected $config = [];
+
+	/**
+	 * Extra Provider parameters.
+	 *
+	 * @var array
+	 */
+	protected $params;
+
+	/**
+	 * Callback url
+	 *
+	 * @var string
+	 */
+	protected $callback = '';
+
+	/**
+	 * Storage.
+	 *
+	 * @var StorageInterface
+	 */
+	public $storage;
+
+	/**
+	 * HttpClient.
+	 *
+	 * @var HttpClientInterface
+	 */
+	public $httpClient;
+
+	/**
+	 * Logger.
+	 *
+	 * @var LoggerInterface
+	 */
+	public $logger;
+
+	/**
+	 * Whether to validate API status codes of http responses
+	 *
+	 * @var bool
+	 */
+	protected $validateApiResponseHttpCode = true;
+
+	/**
+	 * Common adapters constructor.
+	 *
+	 * @param array $config
+	 * @param HttpClientInterface $httpClient
+	 * @param StorageInterface $storage
+	 * @param LoggerInterface $logger
+	 */
+	public function __construct(
+		$config = [],
+		HttpClientInterface $httpClient = null,
+		StorageInterface $storage = null,
+		LoggerInterface $logger = null
+	) {
+		$this->providerId = (new \ReflectionClass($this))->getShortName();
+
+		$this->config = new Data\Collection($config);
+
+		$this->setHttpClient($httpClient);
+
+		$this->setStorage($storage);
+
+		$this->setLogger($logger);
+
+		$this->configure();
+
+		$this->logger->debug(sprintf('Initialize %s, config: ', get_class($this)), $config);
+
+		$this->initialize();
+	}
+
+	/**
+	 * Load adapter's configuration
+	 */
+	abstract protected function configure();
+
+	/**
+	 * Adapter initializer
+	 */
+	abstract protected function initialize();
+
+	/**
+	 * {@inheritdoc}
+	 */
+	abstract public function isConnected();
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function apiRequest($url, $method = 'GET', $parameters = [], $headers = [], $multipart = false)
+	{
+		throw new NotImplementedException('Provider does not support this feature.');
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function maintainToken()
+	{
+		// Nothing needed for most providers
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getUserProfile()
+	{
+		throw new NotImplementedException('Provider does not support this feature.');
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getUserContacts()
+	{
+		throw new NotImplementedException('Provider does not support this feature.');
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getUserPages()
+	{
+		throw new NotImplementedException('Provider does not support this feature.');
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getUserActivity($stream)
+	{
+		throw new NotImplementedException('Provider does not support this feature.');
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function setUserStatus($status)
+	{
+		throw new NotImplementedException('Provider does not support this feature.');
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function setPageStatus($status, $pageId)
+	{
+		throw new NotImplementedException('Provider does not support this feature.');
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function disconnect()
+	{
+		$this->clearStoredData();
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getAccessToken()
+	{
+		$tokenNames = [
+			'access_token',
+			'access_token_secret',
+			'token_type',
+			'refresh_token',
+			'expires_in',
+			'expires_at',
+		];
+
+		$tokens = [];
+
+		foreach ($tokenNames as $name) {
+			if ($this->getStoredData($name)) {
+				$tokens[$name] = $this->getStoredData($name);
+			}
+		}
+
+		return $tokens;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function setAccessToken($tokens = [])
+	{
+		$this->clearStoredData();
+
+		foreach ($tokens as $token => $value) {
+			$this->storeData($token, $value);
+		}
+
+		// Re-initialize token parameters.
+		$this->initialize();
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function setHttpClient(HttpClientInterface $httpClient = null)
+	{
+		$this->httpClient = $httpClient ?: new HttpClient();
+
+		if ($this->config->exists('curl_options') && method_exists($this->httpClient, 'setCurlOptions')) {
+			$this->httpClient->setCurlOptions($this->config->get('curl_options'));
+		}
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getHttpClient()
+	{
+		return $this->httpClient;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function setStorage(StorageInterface $storage = null)
+	{
+		$this->storage = $storage ?: new Session();
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getStorage()
+	{
+		return $this->storage;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function setLogger(LoggerInterface $logger = null)
+	{
+		$this->logger = $logger ?: new Logger(
+			$this->config->get('debug_mode'),
+			$this->config->get('debug_file')
+		);
+
+		if (method_exists($this->httpClient, 'setLogger')) {
+			$this->httpClient->setLogger($this->logger);
+		}
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getLogger()
+	{
+		return $this->logger;
+	}
+
+	/**
+	 * Set Adapter's API callback url
+	 *
+	 * @param string $callback
+	 *
+	 * @throws InvalidArgumentException
+	 */
+	protected function setCallback($callback)
+	{
+		if (!filter_var($callback, FILTER_VALIDATE_URL)) {
+			throw new InvalidArgumentException('A valid callback url is required.');
+		}
+
+		$this->callback = $callback;
+	}
+
+	/**
+	 * Overwrite Adapter's API endpoints
+	 *
+	 * @param array|Data\Collection $endpoints
+	 */
+	protected function setApiEndpoints($endpoints = null)
+	{
+		if (empty($endpoints)) {
+			return;
+		}
+
+		$collection = is_array($endpoints) ? new Data\Collection($endpoints) : $endpoints;
+
+		$this->apiBaseUrl = $collection->get('api_base_url') ?: $this->apiBaseUrl;
+		$this->authorizeUrl = $collection->get('authorize_url') ?: $this->authorizeUrl;
+		$this->accessTokenUrl = $collection->get('access_token_url') ?: $this->accessTokenUrl;
+	}
+
+
+	/**
+	 * Validate signed API responses Http status code.
+	 *
+	 * Since the specifics of error responses is beyond the scope of RFC6749 and OAuth Core specifications,
+	 * Hybridauth will consider any HTTP status code that is different than '200 OK' as an ERROR.
+	 *
+	 * @param string $error String to pre append to message thrown in exception
+	 *
+	 * @throws HttpClientFailureException
+	 * @throws HttpRequestFailedException
+	 */
+	protected function validateApiResponse($error = '')
+	{
+		$error .= !empty($error) ? '. ' : '';
+
+		if ($this->httpClient->getResponseClientError()) {
+			throw new HttpClientFailureException(
+				$error . 'HTTP client error: ' . $this->httpClient->getResponseClientError() . '.'
+			);
+		}
+
+		// if validateApiResponseHttpCode is set to false, we by pass verification of http status code
+		if (!$this->validateApiResponseHttpCode) {
+			return;
+		}
+
+		$status = $this->httpClient->getResponseHttpCode();
+
+		if ($status < 200 || $status > 299) {
+			throw new HttpRequestFailedException(
+				$error . 'HTTP error ' . $this->httpClient->getResponseHttpCode() .
+				'. Raw Provider API response: ' . $this->httpClient->getResponseBody() . '.'
+			);
+		}
+	}
 }

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;
+	}
 }