added graphql api call for private app

Author: kshitij verma

.idea/.gitignore

@@ -1,11 +1,13 @@
 <?php
 namespace Shopify;
 
+use GuzzleHttp\Exception\RequestException;
 use Shopify\Common\ClientInterface;
 use Shopify\Exception\ApiException;
 
 /**
  * Class Client
+ * @package Shopify
  */
 class Client implements ClientInterface
 {
@@ -24,97 +26,109 @@ class Client implements ClientInterface
      */
     const SHOPIFY_ACCESS_TOKEN = 'X-Shopify-Access-Token';
 
+    /**
+     * denine response header pagination string
+     */
+    const PAGINATION_STRING = 'Link';
+
     /**
      * response header parameter of shopify api limit
      */
-    const SHOPIFY_API_LIMIT_HEADER = 'http_x_shopify_shop_api_call_limit';
+    const API_CALL_RATE_LIMIT_HEADER = 'http_x_shopify_shop_api_call_limit';
 
     /**
      * define graphQL api call
      */
     const GRAPHQL = 'graphql';
 
     /**
-     * @var string
      * Shopify graphql base url
+     * @var string
      */
     protected $graphql_api_url = "https://{shopify_domain}/admin/api/{version}/graphql.json";
 
     /**
-     * @var string
      * Shopify domain name
+     * @var string
      */
     protected $shop;
 
     /**
-     * @var string
      * Shopify api key
+     * @var string
      */
     protected $api_key;
 
     /**
-     * @var string
      * Shopify password for private app
+     * @var string
      */
     protected $password;
 
     /**
-     * @var string
      * Shopify shared secret key for private app
+     * @var string
      */
     protected $shared_secret;
 
     /**
+     * array('version')
      * @var array
-     * array of version
      */
     protected $api_params;
 
     /**
-     * @var array
      * Shopify api call url
+     * @var array
      */
     protected $base_urls;
 
     /**
-     * @var array
      * get api header array according to private and public app
+     * @var array
      */
     protected $requestHeaders;
 
     /**
-     * @var string
      * Shopify api version
+     * @var string
      */
     protected $api_version;
 
     /**
+     * get response header
      * @var string
+     */
+    protected $next_page;
+
+    /**
      * get response header
+     * @var string
      */
-    private $last_response_headers;
+    protected $prev_page;
 
     /**
-     *
+     * static variable to api is going to reach
+     * @var bool
      */
-    public function init(){
-        echo "hello";
-    }
+    protected static $wait_next_api_call = false;
 
     /**
+     * prepare data for rest api request
      * @param $method
-     * @param $query
+     * @param $path
      * @param array $params
-     * @return mixed|void
+     * @return array
      * @throws ApiException
+     * @throws ClientException
      */
     public function call($method, $path , array $params = [])
     {
         $url = $this->base_urls[self::REST_API];
         $options = [];
         $allowed_http_methods = $this->getHttpMethods();
         if(!in_array($method, $allowed_http_methods)){
-            throw new ApiException(implode(",",$allowed_http_methods)." http methods are allowed.");
+            throw new ApiException(implode(",",$allowed_http_methods)." http methods are allowed.",0);
         }
         if(isset($this->requestHeaders[self::REST_API]) && is_array($this->requestHeaders[self::REST_API])) {
             $options['headers'] = $this->requestHeaders[self::REST_API];
@@ -130,74 +144,176 @@ public function call($method, $path , array $params = [])
         return $this->request($method,$url,$options);
     }
 
-    public function callGraphql($method, $query)
+    /**
+     * prepare data for graphql api request
+     * @param string $query
+     * @return mixed|void
+     * @throws ApiException
+     * @throws ClientException
+     */
+    public function callGraphql($query)
     {
         $url = $this->base_urls[self::GRAPHQL];
         $options = [];
-        $allowed_http_methods = $this->getHttpMethods();
-        if(!in_array($method, $allowed_http_methods))
-        {
-            throw new ApiException(implode(",",$allowed_http_methods)." http methods are allowed.");
-        }
         if(isset($this->requestHeaders[self::GRAPHQL]) && is_array($this->requestHeaders[self::GRAPHQL])) {
             $options['headers'] = $this->requestHeaders[self::GRAPHQL];
         }
-        $options['body'] = json_encode([
-            'query' => $query,
-        ]);
-       // var_dump($options);die;
-        return $this->request($method,$url,$options);
+
+        $options['body'] = $query;
+        if(self::$wait_next_api_call)
+        {
+            usleep(1000000 * rand(3, 6));
+        }
+        $response = $this->request('POST', $url, $options);
+        if(isset($response['errors']))
+        {
+            $http_bad_request_code = 400;
+            throw new ApiException(\GuzzleHttp\json_encode($response['errors']),$http_bad_request_code);
+        }
     }
 
+    /**
+     * send http request
+     * @param string $method
+     * @param string $url
+     * @param array $options
+     * @return array|mixed
+     * @throws ApiException
+     */
     public function request($method,$url,array $options)
     {
-        $client  = new \GuzzleHttp\Client();
-        $http_response = $client->request($method, $url, $options);
-        echo "<pre>";
-        print_r($http_response->getBody()->getContents());
-        print_r($http_response->getHeader(self::SHOPIFY_API_LIMIT_HEADER));
-        print_r($http_response->getStatusCode());
-        print_r($http_response->getHeaders());
-        die;
+        try
+        {
+            $client  = new \GuzzleHttp\Client();
+            $http_response = $client->request($method, $url, $options);
+            $response_content = $http_response->getBody()->getContents();
+            $response = [];
+            if (strtoupper($method) === 'GET'  && $http_response->getHeaderLine(self::PAGINATION_STRING)) {
+                $this->next_page = $this->parseLinkString($http_response->getHeaderLine(self::PAGINATION_STRING),'next');
+                $this->prev_page = $this->parseLinkString($http_response->getHeaderLine(self::PAGINATION_STRING),'previous');
+            }
+
+            $response = \GuzzleHttp\json_decode($response_content,true);
+            if($http_response->getHeaderLine(self::API_CALL_RATE_LIMIT_HEADER)) {
+                list($api_call_requested, $api_call_Limit) = explode('/', $http_response->getHeaderLine(self::API_CALL_RATE_LIMIT_HEADER));
+                static::$wait_next_api_call = $api_call_requested / $api_call_Limit >= 0.8;
+            }
+        }
+        catch (RequestException $e)
+        {
+            $json_error = json_decode($e->getResponse()->getBody()->getContents(),true);
+            if(isset($json_error['errors'])) {
+                $error_message = $json_error['errors'];
+            }
+            else {
+                $error_message = $e->getResponse()->getBody()->getContents();
+            }
+            throw new ApiException($error_message,$e->getCode());
+        }
+        return $response;
     }
 
+    /**
+     * get previous page_info for any resource(products/orders)
+     * @return string
+     */
+    public function getPrevPage()
+    {
+        return $this->prev_page;
+    }
 
     /**
+     * check previous page_info for any resource(products/orders)
+     * @return string
+     */
+    public function hasPrevPage()
+    {
+        return !empty($this->prev_page);
+    }
+
+    /**
+     * get next page_info for any resource(products/orders)
+     * @return string
+     */
+    public function getNextPage(){
+        return $this->next_page;
+    }
+
+    /**
+     * check next page_info for any resource(products/orders)
+     * @return string
+     */
+    public function hasNextPage(){
+        return !empty($this->next_page);
+    }
+
+    /**
+     * parse header string for previous and next page_info
+     * @param $pagination_string
+     * @param $page_link
+     * @return string
+     */
+    public function parseLinkString($pagination_string,$page_link)
+    {
+        $matches = [];
+        preg_match("/<(.*page_info=([a-z0-9\-]+).*)>; rel=\"?{$page_link}\"?/i", $pagination_string, $matches);
+        return isset($matches[2]) ? $matches[2] : NULL;
+    }
+
+
+    /**
+     * return latest api version
      * @return string
-     * @throws ApiException
      */
     public function getApiVersion()
     {
         return $this->api_version;
     }
 
+    /**
+     * set api version
+     * @param api_version
+     * Exception for valid value
+     * @throws ApiException
+     */
     protected function setApiVersion()
     {
         $this->api_version = !empty($this->api_params['version'])?$this->api_params['version']:self::SHOPIFY_API_VERSION;
         if (!preg_match('/^[0-9]{4}-[0-9]{2}$|^unstable$/', $this->api_version))
         {
-            throw new ApiException('Api Version must be of YYYY-MM or unstable');
+            throw new ApiException('Api Version must be of YYYY-MM or unstable',0);
         }
     }
 
     /**
+     * return allowed http api methods
      * @return array
      */
     public function getHttpMethods()
     {
         return ['POST', 'PUT','GET', 'DELETE'];
     }
 
+    /**
+     * set shopify domain
+     * @param $shop
+     * Exception for invalid shop name
+     * @throws ApiException
+     */
     protected function setShop($shop)
     {
         if (!preg_match('/^[a-zA-Z0-9\-]{3,100}\.myshopify\.(?:com|io)$/', $shop)) {
             throw new ApiException(
-                'Shop name should be 3-100 letters, numbers, or hyphens eg mypetstore.myshopify.com'
+                'Shop name should be 3-100 letters, numbers, or hyphens eg mypetstore.myshopify.com',0
             );
         }
         $this->shop = $shop;
     }
 
+    /**
+     * return shopify domain
+     * @return string
+     */
     public function getShop()
     {
         return $this->shop;

src/Client.php

@@ -20,7 +20,7 @@ public function call($method, $path, array $params);
      * @param string $query
      * @return mixed
      */
-    public function callGraphql($method, $query);
+    public function callGraphql($query);
 
     /**
      * @param string $method

src/Common/ClientInterface.php

@@ -6,25 +6,28 @@
  */
 class ApiException extends \Exception
 {
-    /*protected $method;
-    protected $path;
-    protected $params;
-    protected $response_headers;
-    protected $response;
+    /**
+     * @var string
+     * store error message
+     */
+    protected $message;
 
-    function __construct($method, $path, $params, $response_headers, $response)
+    /**
+     * ApiException constructor.
+     * @param $message
+     * @param $code
+     */
+    function __construct($message,$code)
     {
-        $this->method = $method;
-        $this->path = $path;
-        $this->params = $params;
-        $this->response_headers = $response_headers;
-        $this->response = $response;
-        parent::__construct($response_headers['http_status_message'], $response_headers['http_status_code']);
+        $this->message = $message;
+        parent::__construct($message, $code);
     }
 
-    function getMethod() { return $this->method; }
-    function getPath() { return $this->path; }
-    function getParams() { return $this->params; }
-    function getResponseHeaders() { return $this->response_headers; }
-    function getResponse() { return $this->response; }*/
+    /**
+     * @return string
+     * get error message
+     */
+    function getError() {
+        return $this->message;
+    }
 }