Merge pull request #174 from Insti/Timeout_Improvements

Obvious timeout error message.

Author: drewm

src/MailChimp.php

@@ -15,6 +15,8 @@ class MailChimp
     private $api_key;
     private $api_endpoint = 'https://<dc>.api.mailchimp.com/3.0';
 
+    const TIMEOUT = 10;
+
     /*  SSL Verification
         Read before disabling:
         http://snippets.webaware.com.au/howto/stop-turning-off-curlopt_ssl_verifypeer-and-fix-your-php-config/
@@ -113,7 +115,7 @@ public function getLastRequest()
      * @param   int $timeout Timeout limit for request in seconds
      * @return  array|false   Assoc array of API response, decoded from JSON
      */
-    public function delete($method, $args = array(), $timeout = 10)
+    public function delete($method, $args = array(), $timeout = self::TIMEOUT)
     {
         return $this->makeRequest('delete', $method, $args, $timeout);
     }
@@ -125,7 +127,7 @@ public function delete($method, $args = array(), $timeout = 10)
      * @param   int $timeout Timeout limit for request in seconds
      * @return  array|false   Assoc array of API response, decoded from JSON
      */
-    public function get($method, $args = array(), $timeout = 10)
+    public function get($method, $args = array(), $timeout = self::TIMEOUT)
     {
         return $this->makeRequest('get', $method, $args, $timeout);
     }
@@ -137,7 +139,7 @@ public function get($method, $args = array(), $timeout = 10)
      * @param   int $timeout Timeout limit for request in seconds
      * @return  array|false   Assoc array of API response, decoded from JSON
      */
-    public function patch($method, $args = array(), $timeout = 10)
+    public function patch($method, $args = array(), $timeout = self::TIMEOUT)
     {
         return $this->makeRequest('patch', $method, $args, $timeout);
     }
@@ -149,7 +151,7 @@ public function patch($method, $args = array(), $timeout = 10)
      * @param   int $timeout Timeout limit for request in seconds
      * @return  array|false   Assoc array of API response, decoded from JSON
      */
-    public function post($method, $args = array(), $timeout = 10)
+    public function post($method, $args = array(), $timeout = self::TIMEOUT)
     {
         return $this->makeRequest('post', $method, $args, $timeout);
     }
@@ -161,7 +163,7 @@ public function post($method, $args = array(), $timeout = 10)
      * @param   int $timeout Timeout limit for request in seconds
      * @return  array|false   Assoc array of API response, decoded from JSON
      */
-    public function put($method, $args = array(), $timeout = 10)
+    public function put($method, $args = array(), $timeout = self::TIMEOUT)
     {
         return $this->makeRequest('put', $method, $args, $timeout);
     }
@@ -175,7 +177,7 @@ public function put($method, $args = array(), $timeout = 10)
      * @return array|false Assoc array of decoded result
      * @throws \Exception
      */
-    private function makeRequest($http_verb, $method, $args = array(), $timeout = 10)
+    private function makeRequest($http_verb, $method, $args = array(), $timeout = self::TIMEOUT)
     {
         if (!function_exists('curl_init') || !function_exists('curl_setopt')) {
             throw new \Exception("cURL support is required, but can't be found.");
@@ -245,10 +247,10 @@ private function makeRequest($http_verb, $method, $args = array(), $timeout = 10
 
         $responseContent = curl_exec($ch);
 
+        $response['headers'] = curl_getinfo($ch);
         if ($responseContent === false) {
             $this->last_error = curl_error($ch);
         } else {
-            $response['headers'] = curl_getinfo($ch);
             $headerSize = $response['headers']['header_size'];
 
             $response['httpHeaders'] = $this->getHeadersAsArray(substr($responseContent, 0, $headerSize));
@@ -263,7 +265,7 @@ private function makeRequest($http_verb, $method, $args = array(), $timeout = 10
 
         $formattedResponse = $this->formatResponse($response);
 
-        $this->determineSuccess($response, $formattedResponse);
+        $this->determineSuccess($response, $formattedResponse, $timeout);
 
         return $formattedResponse;
     }
@@ -371,9 +373,10 @@ private function formatResponse($response)
      * Check if the response was successful or a failure. If it failed, store the error.
      * @param array $response The response from the curl request
      * @param array|false $formattedResponse The response body payload from the curl request
+     * @param int $timeout The timeout supplied to the curl request.
      * @return bool     If the request was successful
      */
-    private function determineSuccess($response, $formattedResponse)
+    private function determineSuccess($response, $formattedResponse, $timeout)
     {
         $status = $this->findHTTPStatus($response, $formattedResponse);
 
@@ -387,6 +390,11 @@ private function determineSuccess($response, $formattedResponse)
             return false;
         }
 
+        if( $timeout > 0 && $response['headers'] && $response['headers']['total_time'] >= $timeout ) {
+            $this->last_error = sprintf('Request timed out after %f seconds.', $response['headers']['total_time'] );
+            return false;
+        }
+
         $this->last_error = 'Unknown error, call getLastResponse() to find out what happened.';
         return false;
     }

tests/MailChimpTest.php

@@ -73,4 +73,29 @@ public function testResponseState()
         $this->assertTrue($MailChimp->success());
     }
 
-}
+    /* This test requires that your test list have:
+     * a) a list
+     * b) enough entries that the curl request will timeout after 1 second.
+     * How many this is may depend on your network connection to the Mailchimp servers.
+     */
+    public function testRequestTimeout()
+    {
+        $MC_API_KEY = getenv('MC_API_KEY');
+
+        if (!$MC_API_KEY) {
+            $this->markTestSkipped('No API key in ENV');
+        }
+
+        $MailChimp = new MailChimp($MC_API_KEY);
+        $result = $MailChimp->get('lists');
+        $list_id = $result['lists'][0]['id'];
+
+        $args = array( 'count' => 1000 );
+        $timeout = 1;
+        $result = $MailChimp->get("lists/$list_id/members", $args, $timeout );
+        $this->assertFalse( $result );
+
+        $error = $MailChimp->getLastError();
+        $this->assertRegExp( '/Request timed out after 1.\d+ seconds/', $error );
+    }
+}