API-38: Added default timeout of 30 secs

Author: ekta-slit

DependencyInjection/Configuration.php

@@ -25,6 +25,7 @@ public function getConfigTreeBuilder()
         // more information on that topic.
         $rootNode->children()
                     ->scalarNode('api_key')->isRequired()->cannotBeEmpty()->end()
+                    ->scalarNode('timeout')->defaultValue(30000)->end() //default timeout: 30 secs
                   ->end();
 
         return $treeBuilder;

README.md

@@ -60,6 +60,8 @@ In your `app/config/config.yml`:
 ```yaml
 sendin_blue_api:
     api_key: <Your access key>
+    # Our library supports a timeout value, which is an optional parameter, default is 30,000 MS ( 30 secs )
+    timeout: 5000
 ```
 
 

Wrapper/Mailin.php

@@ -13,19 +13,20 @@
 
 class Mailin
 {
-    public $api_key;
+    public $parameters;
     public $base_url;
     public $curl_opts = array();
 
-    public function __construct($api_key)
+    public function __construct($parameters)
     {
         if(!function_exists('curl_init')) 
         {
             throw new \RuntimeException('Mailin requires cURL module');
         }
-        $this->config = $api_key;
+        $this->config = $parameters;
         $this->base_url = "https://api.sendinblue.com/v2.0";
         $this->api_key = $this->config['api_key'];
+        $this->timeout = $this->config['timeout'];
     }
     /**
      * Do CURL request with authorization
@@ -36,6 +37,9 @@ 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";
+        if (isset($this->timeout) && ($this->timeout <= 0 || $this->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);
@@ -44,14 +48,15 @@ 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, $this->timeout);
         curl_setopt($ch, CURLOPT_HEADER, 0);
         curl_setopt($ch, CURLOPT_POSTFIELDS, $input);
 
         $data = curl_exec($ch);
         $info = curl_getinfo($ch);
         if(curl_errno($ch))
         {
-            throw new \RuntimeException('Curl error: ' . curl_error($ch));
+            throw new \RuntimeException('cURL error: ' . curl_error($ch));
         }
         curl_close($ch);
         return json_decode($data,true);