Merge pull request #49 from rosette-api/RCB-454_concurrency

Updated to use the concurrency returned from Rosette API

Author: hgaudet

source/rosette/api/Api.php

@@ -96,13 +96,6 @@ class Api
      */
     private $ms_between_retries;
 
-    /**
-     * request override - for testing
-     *
-     * @RosetteRequest
-     */
-    private $mock_request;
-
     /**
      * internal options array
      * @var array
@@ -115,6 +108,11 @@ class Api
      */
     private $customHeaders;
 
+    /**
+     * internal Request object
+     * @var array
+     */
+    private $request;
 
     /**
      * Create an L{API} object.
@@ -143,7 +141,7 @@ public function __construct($user_key, $service_url  = 'https://api.rosette.com/
         $this->subUrl = null;
         $this->max_retries = 5;
         $this->ms_between_retries = 500000;
-        $this->mock_request = null;
+        $this->request = new RosetteRequest();
         $this->options = array();
     }
 
@@ -154,7 +152,7 @@ public function __construct($user_key, $service_url  = 'https://api.rosette.com/
      */
     public function setMockRequest($requestObject)
     {
-        $this->mock_request = $requestObject;
+        $this->request = $requestObject;
     }
 
     /**
@@ -368,6 +366,17 @@ public function clearCustomHeaders()
     }
 
 
+    /**
+     * Returns the max connections (concurrency)
+     *
+     * @return int
+     */
+    public function getMaxConnections()
+    {
+        return $this->request->getMaxConnections();
+    }
+
+
     /**
      * Replaces a header item with a new one
      */
@@ -448,25 +457,25 @@ private function callEndpoint($parameters, $subUrl)
      */
     private function makeRequest($url, $headers, $data, $method)
     {
-        $request = $this->mock_request != null ? $this->mock_request : new RosetteRequest();
         for ($retries = 0; $retries < $this->max_retries; $retries++) {
-            if ($request->makeRequest($url, $headers, $data, $method) === false) {
-                throw new RosetteException($request->getResponseError);
+            if ($this->request->makeRequest($url, $headers, $data, $method) === false) {
+                throw new RosetteException($this->request->getResponseError);
             } else {
-                $this->setResponseCode($request->getResponseCode());
+                $this->setResponseCode($this->request->getResponseCode());
                 if ($this->getResponseCode() === 429) {
+                    print('429 RETRY');
                     usleep($this->ms_between_retries);
                     continue;
                 } elseif ($this->getResponseCode() !== 200) {
-                    throw new RosetteException($request->getResponse()['message'], $this->getResponseCode());
+                    throw new RosetteException($this->request->getResponse()['message'], $this->getResponseCode());
                 }
-                return $request->getResponse();
+                return $this->request->getResponse();
             }
         }
         if ($this->getResponseCode() !== 200) {
-            throw new RosetteException($request->getResponse()['message'], $this->getResponseCode());
+            throw new RosetteException($this->request->getResponse()['message'], $this->getResponseCode());
         } else {
-            return $request->getResponse();
+            return $this->request->getResponse();
         }
     }
 
@@ -607,24 +616,25 @@ public function morphology($params, $facet = null)
         return $this->callEndpoint($params, 'morphology/' . $facet);
     }
 
-      /* Calls the entities endpoint.
-      *
-      * @param $params
-      * @param $resolve_entities
-      *
-      * @return mixed
-      *
-      * @throws RosetteException
-      */
-      public function entities($params, $resolve_entities = false)
-     {
+    /** 
+     * Calls the entities endpoint.
+     *
+     * @param $params
+     * @param $resolve_entities
+     *
+     * @return mixed
+     *
+     * @throws RosetteException
+     */
+    public function entities($params, $resolve_entities = false)
+    {
         if ($resolve_entities == true) {
             error_reporting(E_DEPRECATED);
             return $this->callEndpoint($params, 'entities/linked');
         } else {
             return $this->callEndpoint($params, 'entities');
         }
-     }
+    }
 
 
     /**

source/rosette/api/RosetteRequest.php

@@ -66,6 +66,12 @@ class RosetteRequest
      * @var bool
      */
     private $initialized;
+    /**
+     * Maximum connections
+     *
+     * @var int
+     */
+    private $max_connections;
 
     /**
      * class constructor
@@ -74,6 +80,7 @@ class RosetteRequest
     public function __construct()
     {
         $this->initialized = false;
+        $this->max_connections = 1;
     }
 
     /**
@@ -116,6 +123,7 @@ public function makeRequest($url, $headers, $data, $method)
             curl_setopt($this->curl_handle, CURLOPT_HTTPGET, true);
         }
 
+        curl_setopt($this->curl_handle, CURLOPT_MAXCONNECTS, $this->max_connections);
         curl_setopt($this->curl_handle, CURLOPT_HEADER, 1);
         curl_setopt($this->curl_handle, CURLOPT_RETURNTRANSFER, true);
         $this->response = curl_exec($this->curl_handle);
@@ -195,6 +203,14 @@ public function getResponse()
     {
         if ($this->response !== false) {
             $response = [ 'headers' => $this->headersToArray() ];
+
+            if (array_key_exists('X-RosetteAPI-Concurrency', $response['headers'])) {
+                $concurrency = $response['headers']['X-RosetteAPI-Concurrency'];
+                if ($concurrency != $this->max_connections) {
+                    $this->max_connections = $concurrency;
+                }
+            }
+
             $responseBody = $this->getResponseBody();
             if (empty($responseBody)) {
                 $response = array_merge($response, [ 'body' => 'empty' ]);
@@ -208,6 +224,15 @@ public function getResponse()
         return $response;
     }
 
+    /**
+     * Gets the maximum number of connections allowed
+     *
+     * @return int 
+     */
+    public function getMaxConnections()
+    {
+        return $this->max_connections;
+    }
 
     /**
      * function headersToArray

spec/rosette/api/ApiSpec.php

@@ -1,7 +1,9 @@
 <?php
 namespace spec\rosette\api;
+
 use PhpSpec\ObjectBehavior;
 use Prophecy\Argument;
+
 class ApiSpec extends ObjectBehavior
 {
     public function let()
@@ -51,6 +53,10 @@ public function it_sets_gets_debug()
         $this->setDebug($debug);
         $this->getDebug()->shouldBe($debug);
     }
+    public function it_gets_max_connections()
+    {
+        $this->getMaxConnections()->shouldBe(1);
+    }
     public function it_can_ping($request)
     {
         $request->beADoubleOf('rosette\api\RosetteRequest');
@@ -230,4 +236,4 @@ public function it_fails_with_409_response($params, $request)
         $this->setMockRequest($request);
         $this->shouldThrow('rosette\api\RosetteException')->duringRelationships($params);
     }
-}
+}

spec/rosette/api/RosetteRequestSpec.php

@@ -1,21 +1,11 @@
 <?php
-
 namespace spec\rosette\api;
 
 use PhpSpec\ObjectBehavior;
 use Prophecy\Argument;
 
 class RosetteRequestSpec extends ObjectBehavior
 {
-    public function let()
-    {
-        $headers = array("X-RosetteAPI-Key: user_key",
-                          "Content-Type: application/json",
-                          "Accept: application/json",
-                          "Accept-Encoding: gzip",);
-        $this->beConstructedWith('https://api.rosette.com/rest/v1', null, $headers, 'GET');
-    }
-
     public function it_is_initializable()
     {
         $this->shouldHaveType('\rosette\api\RosetteRequest');
@@ -35,4 +25,9 @@ public function it_returns_a_response()
     {
         $this->getResponse()->shouldBeArray();
     }
+
+    public function it_gets_max_connections()
+    {
+        $this->getMaxConnections()->shouldBe(1);
+    }
 }