Merge pull request hybridauth#1255 from chrisgraham/instagram_token_exchange

Implemented Token Exchange for Instagram

Author: ApacheEx

src/Adapter/AbstractAdapter.php

@@ -136,6 +136,14 @@ public function apiRequest($url, $method = 'GET', $parameters = [], $headers = [
         throw new NotImplementedException('Provider does not support this feature.');
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function maintainToken()
+    {
+        // Nothing needed for most providers
+    }
+
     /**
      * {@inheritdoc}
      */

src/Adapter/AdapterInterface.php

@@ -97,6 +97,12 @@ public function setPageStatus($status, $pageId);
      */
     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.
      *

src/Adapter/OAuth1.php

@@ -544,6 +544,9 @@ protected function validateAccessTokenExchange($response)
      */
     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, '/');
         }

src/Adapter/OAuth2.php

@@ -710,6 +710,7 @@ protected function validateRefreshAccessToken($response)
     public function apiRequest($url, $method = 'GET', $parameters = [], $headers = [], $multipart = false)
     {
         // refresh tokens if needed
+        $this->maintainToken();
         if ($this->hasAccessTokenExpired() === true) {
             $this->refreshAccessToken();
         }

src/Provider/Facebook.php

@@ -92,8 +92,12 @@ protected function initialize()
     /**
      * {@inheritdoc}
      */
-    public function apiRequest($url, $method = 'GET', $parameters = [], $headers = [], $multipart = false)
+    public function maintainToken()
     {
+        if (!$this->isConnected()) {
+            return;
+        }
+
         // Handle token exchange prior to the standard handler for an API request
         $exchange_by_expiry_days = $this->config->get('exchange_by_expiry_days') ?: 45;
         if ($exchange_by_expiry_days !== null) {
@@ -102,8 +106,6 @@ public function apiRequest($url, $method = 'GET', $parameters = [], $headers = [
                 $this->exchangeAccessToken();
             }
         }
-
-        return parent::apiRequest($url, $method, $parameters, $headers, $multipart);
     }
 
     /**

src/Provider/Instagram.php

@@ -55,6 +55,75 @@ protected function initialize()
         $this->apiRequestParameters[$this->accessTokenName] = $accessToken;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    protected function validateAccessTokenExchange($response)
+    {
+        $collection = parent::validateAccessTokenExchange($response);
+
+        if (!$collection->exists('expires_in')) {
+            // Instagram tokens always expire in an hour, but this is implicit not explicit
+
+            $expires_in = 60 * 60;
+
+            $expires_at = time() + $expires_in;
+
+            $this->storeData('expires_in', $expires_in);
+            $this->storeData('expires_at', $expires_at);
+        }
+
+        return $collection;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function maintainToken()
+    {
+        if (!$this->isConnected()) {
+            return;
+        }
+
+        // Handle token exchange prior to the standard handler for an API request
+        $exchange_by_expiry_days = $this->config->get('exchange_by_expiry_days') ?: 45;
+        if ($exchange_by_expiry_days !== null) {
+            $projected_timestamp = time() + 60 * 60 * 24 * $exchange_by_expiry_days;
+            if (!$this->hasAccessTokenExpired() && $this->hasAccessTokenExpired($projected_timestamp)) {
+                $this->exchangeAccessToken();
+            }
+        }
+    }
+
+    /**
+     * Exchange the Access Token with one that expires further in the future.
+     *
+     * @return string Raw Provider API response
+     * @throws \Hybridauth\Exception\HttpClientFailureException
+     * @throws \Hybridauth\Exception\HttpRequestFailedException
+     * @throws InvalidAccessTokenException
+     */
+    public function exchangeAccessToken()
+    {
+        $exchangeTokenParameters = [
+            'grant_type'        => 'ig_exchange_token',
+            'client_secret'     => $this->clientSecret,
+            'access_token'      => $this->getStoredData('access_token'),
+        ];
+
+        $response = $this->httpClient->request(
+            'https://graph.instagram.com/access_token',
+            'GET',
+            $exchangeTokenParameters
+        );
+
+        $this->validateApiResponse('Unable to exchange the access token');
+
+        $this->validateAccessTokenExchange($response);
+
+        return $response;
+    }
+
     /**
      * {@inheritdoc}
      */