AC-14075::Replace carlos-mg89/oauth with PHP Native Functions

Author: djadobe16

dev/tests/api-functional/framework/Magento/TestFramework/Authentication/Rest/OauthService.php

@@ -56,8 +56,7 @@ public function __construct(
         ClientFactory           $clientFactory,
         NonceGeneratorInterface $nonceGenerator,
         Utility                 $utility
-    )
-    {
+    ) {
         $this->urlProvider = $urlProvider;
         $this->clientFactory = $clientFactory;
         $this->_nonceGenerator = $nonceGenerator;
@@ -107,44 +106,21 @@ public function getRequestToken(): array
         $authParameters = ['oauth_consumer_key' => $this->consumerKey];
         $authParameters = $this->getBasicAuthorizationParams($authParameters);
         $requestUrl = $this->getRequestTokenEndpoint();
-        $headers = ['Authorization' => $this->buildAuthorizationHeaderToRequestToken($authParameters, $this->consumerSecret, $requestUrl)];
+        $headers = [
+            'Authorization' => $this->buildAuthorizationHeaderToRequestToken(
+                $authParameters,
+                $this->consumerSecret,
+                $requestUrl
+            )
+        ];
 
         $responseBody = $this->fetchResponse($requestUrl, [], $headers);
         return $this->parseResponseBody($responseBody);
     }
 
     /**
-     * Get request token endpoint.
-     * @return string
-     * @throws \Exception
-     */
-    public function getRequestTokenEndpoint(): string
-    {
-        return $this->urlProvider->getRebuiltUrl(TESTS_BASE_URL . '/oauth/token/request');
-    }
-
-    /**
-     * @param string $url
-     * @param array $requestBody
-     * @param array $headers
-     * @param string $method
-     * @return string
-     */
-    public function fetchResponse(string $url, array $requestBody, array $headers, string $method = 'POST'): string
-    {
-        $httpClient = $this->clientFactory->create();
-        $httpClient->setHeaders($headers);
-        $httpClient->setOption(CURLOPT_FAILONERROR, true);
-        if ($method === 'GET') {
-            $httpClient->get($url);
-        } else {
-            $httpClient->post($url, $requestBody);
-        }
-
-        return $httpClient->getBody();
-    }
-
-    /**
+     * Build header for request token
+     *
      * @param array $params
      * @param string $consumerSecret
      * @param string $requestUrl
@@ -158,8 +134,7 @@ public function buildAuthorizationHeaderToRequestToken(
         string $requestUrl,
         string $signatureMethod = \Magento\Framework\Oauth\Oauth::SIGNATURE_SHA256,
         string $httpMethod = 'POST'
-    ): string
-    {
+    ): string {
         $params['oauth_signature'] = $this->_httpUtility->sign(
             $params,
             $signatureMethod,
@@ -173,6 +148,8 @@ public function buildAuthorizationHeaderToRequestToken(
     }
 
     /**
+     * Get access token
+     *
      * @param array $token
      * @param string $verifier
      * @return array
@@ -201,6 +178,42 @@ public function getAccessToken(array $token, string $verifier): array
     }
 
     /**
+     * Validate access token
+     *
+     * @param array $token
+     * @param string $method
+     * @return array
+     */
+    public function validateAccessToken(array $token, string $method = 'GET'): array
+    {
+        $authParameters = ['oauth_consumer_key' => $this->consumerKey];
+        $authParameters = $this->getBasicAuthorizationParams($authParameters);
+
+        //Need to add Accept header else Magento errors out with 503
+        $extraAuthenticationHeaders = ['Accept' => 'application/json'];
+
+        $authorizationHeader = [
+            'Authorization' => $this->buildAuthorizationHeaderForAPIRequest(
+                $authParameters,
+                $this->consumerSecret,
+                $this->getTestApiEndpoint(),
+                $token,
+                [],
+                \Magento\Framework\Oauth\Oauth::SIGNATURE_SHA256,
+                $method
+            ),
+        ];
+
+        $headers = array_merge($authorizationHeader, $extraAuthenticationHeaders);
+
+        $responseBody = $this->fetchResponse($this->getTestApiEndpoint(), [], $headers, $method);
+
+        return json_decode($responseBody);
+    }
+
+    /**
+     * Build header for api request
+     *
      * @param array $params
      * @param string $consumerSecret
      * @param string $requestUrl
@@ -210,16 +223,15 @@ public function getAccessToken(array $token, string $verifier): array
      * @param string $httpMethod
      * @return string
      */
-    protected function buildAuthorizationHeaderForAPIRequest(
+    public function buildAuthorizationHeaderForAPIRequest(
         array  $params,
         string $consumerSecret,
         string $requestUrl,
         array  $token,
         ?array $bodyParams = null,
         string $signatureMethod = \Magento\Framework\Oauth\Oauth::SIGNATURE_SHA256,
         string $httpMethod = 'POST'
-    ): string
-    {
+    ): string {
 
         if (isset($params['oauth_callback'])) {
             unset($params['oauth_callback']);
@@ -241,46 +253,26 @@ protected function buildAuthorizationHeaderForAPIRequest(
     }
 
     /**
-     * @param array $token
-     * @param string $method
-     * @return array
+     * Request token endpoint.
+     *
+     * @return string
+     * @throws \Exception
      */
-    public function validateAccessToken(array $token, string $method = 'GET'): array
+    public function getRequestTokenEndpoint(): string
     {
-        $authParameters = ['oauth_consumer_key' => $this->consumerKey];
-        $authParameters = $this->getBasicAuthorizationParams($authParameters);
-
-        //Need to add Accept header else Magento errors out with 503
-        $extraAuthenticationHeaders = ['Accept' => 'application/json'];
-
-        $authorizationHeader = [
-            'Authorization' => $this->buildAuthorizationHeaderForAPIRequest(
-                $authParameters,
-                $this->consumerSecret,
-                $this->getTestApiEndpoint(),
-                $token,
-                [],
-                \Magento\Framework\Oauth\Oauth::SIGNATURE_SHA256,
-                $method
-            ),
-        ];
-
-        $headers = array_merge($authorizationHeader, $extraAuthenticationHeaders);
-
-        $responseBody = $this->fetchResponse($this->getTestApiEndpoint(), [], $headers, $method);
-
-        return json_decode($responseBody);
+        return $this->urlProvider->getRebuiltUrl(TESTS_BASE_URL . '/oauth/token/request');
     }
 
     /**
+     * Access token endpoint
+     *
      * @return string
      */
     public function getAccessTokenEndpoint(): string
     {
         return $this->urlProvider->getRebuiltUrl(TESTS_BASE_URL . '/oauth/token/access');
     }
-
-
+    
     /**
      * Returns the TestModule1 Rest API endpoint.
      *
@@ -293,6 +285,29 @@ public function getTestApiEndpoint(): string
         return $this->urlProvider->getRebuiltUrl(TESTS_BASE_URL . '/rest/' . $defaultStoreCode . '/V1/testmodule1');
     }
 
+    /**
+     * Fetch api response using curl client factory
+     *
+     * @param string $url
+     * @param array $requestBody
+     * @param array $headers
+     * @param string $method
+     * @return string
+     */
+    public function fetchResponse(string $url, array $requestBody, array $headers, string $method = 'POST'): string
+    {
+        $httpClient = $this->clientFactory->create();
+        $httpClient->setHeaders($headers);
+        $httpClient->setOption(CURLOPT_FAILONERROR, true);
+        if ($method === 'GET') {
+            $httpClient->get($url);
+        } else {
+            $httpClient->post($url, $requestBody);
+        }
+
+        return $httpClient->getBody();
+    }
+
     /**
      * Parse response body and return data in array.
      *