Merge pull request #85 from rosette-api/ws-3224-add-timeout

WS-3224: request timeout configurable

Author: Katsuya-Tomioka

source/rosette/api/Api.php

@@ -122,6 +122,13 @@ class Api
      */
     private $ms_between_retries;
 
+    /**
+     * The maximum time in seconds to wait for the response to arrive
+     *
+     * @var null|int
+     */
+    private $timeout;
+
     /**
      * Create an L{API} object.
      *
@@ -147,6 +154,7 @@ public function __construct($user_key, $service_url = 'https://api.rosette.com/r
         $this->options = array();
         $this->url_params = array();
         $this->customHeaders = array();
+        $this->timeout = null;
     }
 
     /**
@@ -194,6 +202,15 @@ public function setMillisecondsBetweenRetries($ms_between_retries)
     {
         $this->ms_between_retries = $ms_between_retries;
     }
+    /**
+      * Sets the maximum time in seconds to wait for the response to arrive
+      *
+      * @param int $timeout
+      */
+     public function setTimeout($timeout)
+     {
+         $this->timeout = $timeout;
+     }
 
     /**
      * Returns response code.
@@ -469,7 +486,7 @@ private function callEndpoint($parameters, $subUrl)
      */
     private function makeRequest($url, $headers, $data, $method)
     {
-        if ($this->request->makeRequest($url, $headers, $data, $method, $this->url_params) === false) {
+        if ($this->request->makeRequest($url, $headers, $data, $method, $this->timeout, $this->url_params) === false) {
             throw new RosetteException($this->request->getResponseError());
         } else {
             $this->setResponseCode($this->request->getResponseCode());

source/rosette/api/RosetteRequest.php

@@ -72,18 +72,22 @@ public function __destruct()
      *
      * @return bool
      */
-    public function makeRequest($url, $headers, $data, $method, $url_params = null)
+    public function makeRequest($url, $headers, $data, $method, $timeout, $url_params = null)
     {
         // Unfortunately, the 'options' argument for post and get is NOT for
         // query parameters (as it is in Python). Hence, the construction.
         if (!is_null($url_params)) {
             $url = $url . '?' . http_build_query($url_params);
         }
+        if (is_null($timeout)) {
+            $timeout = 30;
+        }
+        $options = ['timeout' => $timeout]; // Set the timeout here
         try {
             if ($method === 'POST') {
-                $this->response = Requests::post($url, $headers, $data);
+                $this->response = Requests::post($url, $headers, $data, $options);
             } elseif ($method === 'GET') {
-                $this->response = Requests::get($url, $headers);
+                $this->response = Requests::get($url, $headers, $options);
             }
             return true;
         } catch (RequestsException $e) {