API-38: Added default timeout of 30 secs

Author: ekta-slit

V2.0/Mailin.php

@@ -8,15 +8,17 @@ class Mailin
 {
     public $api_key;
     public $base_url;
+    public $timeout;
     public $curl_opts = array();
-    public function __construct($base_url,$api_key)
+    public function __construct($base_url,$api_key,$timeout='')
     {
         if(!function_exists('curl_init')) 
         {
-            throw new Exception('Mailin requires CURL module');
+            throw new RuntimeException('Mailin requires cURL module');
         }
         $this->base_url = $base_url;
         $this->api_key = $api_key;
+        $this->timeout = $timeout;
     }
     /**
      * Do CURL request with authorization
@@ -27,6 +29,10 @@ private function do_request($resource,$method,$input)
         $ch = curl_init($called_url);
         $auth_header = 'api-key:'.$this->api_key;
         $content_header = "Content-Type:application/json";
+        $timeout = ($this->timeout!='')?($this->timeout):30000; //default timeout: 30 secs
+        if ($timeout!='' && ($timeout <= 0 || $timeout > 60000)) {
+            throw new Exception('value not allowed for timeout');
+        }
         if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
             // Windows only over-ride
             curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
@@ -35,12 +41,13 @@ private function do_request($resource,$method,$input)
         curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
         curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
         curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
+        curl_setopt($ch, CURLOPT_TIMEOUT_MS, $timeout);
         curl_setopt($ch, CURLOPT_HEADER, 0);
         curl_setopt($ch, CURLOPT_POSTFIELDS, $input);
         $data = curl_exec($ch);
         if(curl_errno($ch))
         {
-            echo 'Curl error: ' . curl_error($ch). '\n';
+            throw new RuntimeException('cURL error: ' . curl_error($ch));
         }
         curl_close($ch);
         return json_decode($data,true);

V2.0/README.md

@@ -7,6 +7,8 @@ This is the SendinBlue Php library. It implements the various exposed APIs that
 
  * You will need to first get the Access key from [SendinBlue](https://www.sendinblue.com).
 
+ * Our library supports a timeout value, default is 30,000 MS ( 30 secs ), which you can pass as 3rd parameter in Mailin class Object.
+
  * Assuming that you have cloned this git repo, or downloaded Mailin.php and its in the same directory than the script. You can use this small sample script to get started.
 
 ```PHP
@@ -16,7 +18,7 @@ require('Mailin.php');
  * This will initiate the API with the endpoint and your access key.
  *
  */
-$mailin = new Mailin('https://api.sendinblue.com/v2.0','Your access key');  
+$mailin = new Mailin('https://api.sendinblue.com/v2.0','Your access key', 5000);	// Optional parameter: Timeout in MS
 
 /** Prepare variables for easy use **/