Merge pull request #11 from upwork/v2.2.1

Add GraphQL support

Author: mnovozhylov

CHANGES.md

@@ -1,5 +1,8 @@
 # Release History
 
+## 2.3.0
+* Add GraphQL support
+
 ## 2.2.0
 * Send Message to a Batch of Rooms API
 * Milestones::delete was replaced with Milestones::deleteMilestone (breaking!)

composer.json

@@ -1,11 +1,11 @@
 {
     "name": "upwork/php-upwork-oauth2",
     "description": "PHP bindings for Upwork API (OAuth2)",
-    "version": "v2.2.0",
+    "version": "v2.3.0",
     "type": "library",
     "keywords": ["upwork", "php", "api", "oauth2"],
     "homepage": "http://www.upwork.com",
-    "time": "2020-09-18",
+    "time": "2021-12-28",
     "license": "Apache-2.0",
     "authors": [
         {

example/example.php

@@ -32,6 +32,7 @@
 );
 
 $client = new \Upwork\API\Client($config);
+//$client::setOrgUidHeader('1234567890'); // Organization UID (optional)
 
 // $accessTokenInfo has the following structure
 // array('access_token' => ..., 'refresh_token' => ..., 'expires_in' => ...);
@@ -54,3 +55,19 @@
 $auth = new \Upwork\API\Routers\Auth($client);
 $info = $auth->getUserInfo();
 print_r($info);
+
+/*$graphql = new \Upwork\API\Routers\Graphql($client);
+$params['query'] = <<<QUERY
+query {
+  user {
+    id
+    nid
+    rid
+  }
+  organization {
+    id
+  }
+}
+QUERY;
+$data = $graphql->execute($params);
+print_r($data);*/

src/Upwork/API/AuthTypes/OAuth2ClientLib.php

@@ -52,18 +52,25 @@ public function getInstance()
      * @param   string $type Type of request
      * @param   string $url URL
      * @param   array $params (Optional) Parameters
+     * @param   string $tenantId (Optional) Organization UID
      * @access  public
      * @return  mixed
      * @throw	ApiException Invalid method requested
      */
-    public function request($type, $url, $params = array())
+    public function request($type, $url, $params = array(), string $tenantId = null)
     {
 	ApiDebug::p('running request from ' . __CLASS__);
 
 	switch ($type) {
 	    case \League\OAuth2\Client\Provider\AbstractProvider::METHOD_POST:
-	        $options = array('headers' => array('content-type' => 'application/x-www-form-urlencoded'));
-	        $options['body'] = http_build_query($params, null, '&', \PHP_QUERY_RFC3986);
+                if (self::$_epoint == UPWORK_GRAPHQL_EP_NAME) {
+	            $options = array('headers' => array('content-type' => 'application/json'));
+                    is_null($tenantId) || $options['headers']['X-Upwork-API-TenantId'] = $tenantId;
+		    $options['body'] = $params;
+                } else {
+	            $options = array('headers' => array('content-type' => 'application/x-www-form-urlencoded'));
+		    $options['body'] = http_build_query($params, null, '&', \PHP_QUERY_RFC3986);
+                }
 
 		$url = ApiUtils::getFullUrl($url, self::$_epoint);
 		break;
@@ -84,6 +91,9 @@ public function request($type, $url, $params = array())
 	    // do not use getParsedResponse, it returns an array
 	    // but we need a raw json that will be decoded and returned as StdClass object
 	    $response = $this->getInstance()->getResponse($request);
+        } catch (\GuzzleHttp\Exception\ClientException $e) {
+            $eResponse = $e->getResponse();
+            $response = $eResponse->getBody()->getContents();
 	} catch (\Exception $e) {
 	    $response = $e->getResponseBody();
 	}

src/Upwork/API/Client.php

@@ -30,6 +30,11 @@ class Client
      */
     static protected $_epoint = UPWORK_API_EP_NAME;
 
+    /**
+     * @var Organization UID
+     */
+    static protected $_tenantId = null;
+
     /**
      * @var Server instance (AuthTypes)
      */
@@ -112,6 +117,17 @@ public function auth()
         return $this->_server->auth();
     }
 
+    /**
+     * Configure X-Upwork-API-TenantId header
+     *
+     * @param	string	$tenantId (Optional) Organization UID
+     * @return	void
+     */
+    public static function setOrgUidHeader(string $tenantId)
+    {
+        self::$_tenantId = $tenantId;
+    }
+
     /**
      * Run API request
      *
@@ -140,15 +156,17 @@ protected function _request($type, $url, $params = array())
                 break;
         }
 
-        if (self::$_epoint == UPWORK_API_EP_NAME) {
+	if (self::$_epoint == UPWORK_GRAPHQL_EP_NAME) {
+            $params = json_encode($params);
+	} elseif (self::$_epoint == UPWORK_API_EP_NAME) {
             $url = $url . '.' . self::DATA_FORMAT;
         } elseif (self::$_epoint == UPWORK_GDS_EP_NAME) {
             $params['tqx'] = 'out:' . self::DATA_FORMAT;
         }
 
         $this->_server->option('epoint', self::$_epoint);
 
-        $response = $this->_server->request($method, $url, $params);
+        $response = $this->_server->request($method, $url, $params, self::$_tenantId);
 
 	return json_decode($response);
     }

src/Upwork/API/Routers/Graphql.php

@@ -0,0 +1,60 @@
+<?php
+/**
+ * Upwork auth library for using with public API by OAuth
+ * GraphQL
+ *
+ * @final
+ * @package     UpworkAPI
+ * @since       12/28/2021
+ * @copyright   Copyright 2021(c) Upwork.com
+ * @author      Maksym Novozhylov <[email protected]>
+ * @license     Upwork's API Terms of Use {@link https://developers.upwork.com/api-tos.html}
+ */
+
+namespace Upwork\API\Routers;
+
+use Upwork\API\Debug as ApiDebug;
+use Upwork\API\Client as ApiClient;
+
+/**
+ * GraphQL
+ *
+ * @link https://www.upwork.com/developer/
+ */
+final class Graphql extends ApiClient
+{
+    const ENTRY_POINT = UPWORK_GRAPHQL_EP_NAME;
+
+    /**
+     * @var Client instance
+     */
+    private $_client;
+
+    /**
+     * Constructor
+     *
+     * @param   ApiClient $client Client object
+     */
+    public function __construct(ApiClient $client)
+    {
+        ApiDebug::p('init ' . __CLASS__ . ' router');
+        $this->_client = $client;
+        parent::$_epoint = self::ENTRY_POINT;
+    }
+
+    /**
+     * Execute GraphQL request
+     *
+     * @param   array $params List of parameters (query and variables)
+     * @return object
+     */
+    public function execute(array $params)
+    {
+        ApiDebug::p(__FUNCTION__);
+
+        $data = $this->_client->post('', $params);
+        ApiDebug::p('found GraphQL data', $data);
+
+        return $data;
+    }
+}

src/Upwork/API/Utils.php

@@ -37,7 +37,7 @@ static public function getFullUrl($url, $ep = null, $params = null)
             ? 'UPWORK_BASE_URL_' . strtoupper($ep)
             : 'UPWORK_BASE_URL';
 
-	$queryData = is_array($params) ? $queryData = '?' . http_build_query($params) : '';
+	$queryData = (is_array($params) && $ep != UPWORK_GRAPHQL_EP_NAME) ? $queryData = '?' . http_build_query($params) : '';
         $fullUrl = constant($name) . $url . $queryData;
         ApiDebug::p('url', $fullUrl);
 

src/Upwork/API/constants.php

@@ -12,6 +12,8 @@
 
 define('UPWORK_API_EP_NAME', 'api');
 define('UPWORK_GDS_EP_NAME', 'gds');
+define('UPWORK_GRAPHQL_EP_NAME', 'graphql');
 define('UPWORK_BASE_URL', 'https://www.upwork.com');
 define('UPWORK_BASE_URL_API', UPWORK_BASE_URL . '/' . UPWORK_API_EP_NAME);
 define('UPWORK_BASE_URL_GDS', UPWORK_BASE_URL . '/' . UPWORK_GDS_EP_NAME);
+define('UPWORK_BASE_URL_GRAPHQL', 'https://api.upwork.com/graphql');

tests/Upwork/API/Routers/GraphqlTest.php

@@ -0,0 +1,26 @@
+<?php
+namespace Upwork\API\Tests\Routers;
+
+require_once __DIR__  . '/CommonTestRouter.php';
+
+class GraphqlTest extends CommonTestRouter
+{
+    /**
+     * Setup
+     */
+    public function setUp(): void
+    {
+        parent::setUp();
+    }
+
+    /**
+     * @test
+     */
+    public function testExecute()
+    {
+        $router = new \Upwork\API\Routers\Graphql($this->_client);
+        $response = $router->Execute(array('query' => 'query{}'));
+        
+        $this->_checkResponse($response);
+    }
+}