Merge pull request #11 from ninsuo/master

Added curlOptions property to customize curl instance

Author: thinkingserious

lib/Client.php

@@ -29,50 +29,54 @@ class Client
     /** @var array */
     protected $path;
     /** @var array */
+    protected $curlOptions;
+    /** @var array */
     private $methods;
 
     /**
       * Initialize the client
       *
-      * @param string $host    the base url (e.g. https://api.sendgrid.com)
-      * @param array  $headers global request headers
-      * @param string $version api version (configurable)
-      * @param array  $path    holds the segments of the url path
+      * @param string $host        the base url (e.g. https://api.sendgrid.com)
+      * @param array  $headers     global request headers
+      * @param string $version     api version (configurable)
+      * @param array  $path        holds the segments of the url path
+      * @param array  $curlOptions extra options to set during curl initialization
       */
-    public function __construct($host, $headers = null, $version = null, $path = null)
+    public function __construct($host, $headers = null, $version = null, $path = null, $curlOptions = null)
     {
         $this->host = $host;
         $this->headers = $headers ?: [];
         $this->version = $version;
         $this->path = $path ?: [];
+        $this->curlOptions = $curlOptions ?: [];
         // These are the supported HTTP verbs
         $this->methods = ['delete', 'get', 'patch', 'post', 'put'];
     }
-    
+
     /**
      * @return string
      */
     public function getHost()
     {
         return $this->host;
     }
-    
+
     /**
      * @return array
      */
     public function getHeaders()
     {
         return $this->headers;
     }
-    
+
     /**
      * @return string|null
      */
     public function getVersion()
     {
         return $this->version;
     }
-    
+
     /**
      * @return array
      */
@@ -81,6 +85,14 @@ public function getPath()
         return $this->path;
     }
 
+    /**
+     * @return array
+     */
+    public function getCurlOptions()
+    {
+        return $this->curlOptions;
+    }
+
     /**
       * Make a new Client object
       *
@@ -129,12 +141,12 @@ public function makeRequest($method, $url, $body = null, $headers = null)
     {
         $curl = curl_init($url);
 
-        curl_setopt_array($curl, [
+        curl_setopt_array($curl, array_merge([
             CURLOPT_RETURNTRANSFER => true,
             CURLOPT_HEADER => 1,
             CURLOPT_CUSTOMREQUEST => strtoupper($method),
             CURLOPT_SSL_VERIFYPEER => false,
-        ]);
+        ], $this->curlOptions));
 
         if (isset($headers)) {
             $this->headers = array_merge($this->headers, $headers);

test/unit/ClientTest.php

@@ -20,7 +20,7 @@ protected function setUp()
             'Content-Type: application/json',
             'Authorization: Bearer SG.XXXX'
         ];
-        $this->client = new MockClient($this->host, $this->headers, '/v3', null);
+        $this->client = new MockClient($this->host, $this->headers, '/v3', null, null);
     }
 
     public function testConstructor()
@@ -29,6 +29,7 @@ public function testConstructor()
         $this->assertAttributeEquals($this->headers, 'headers', $this->client);
         $this->assertAttributeEquals('/v3', 'version', $this->client);
         $this->assertAttributeEquals([], 'path', $this->client);
+        $this->assertAttributeEquals([], 'curlOptions', $this->client);
         $this->assertAttributeEquals(['delete', 'get', 'patch', 'post', 'put'], 'methods', $this->client);
     }
 
@@ -96,4 +97,13 @@ public function testGetPath()
         $client = new Client('https://localhost:4010', null, null, null);
         $this->assertSame([], $client->getPath());
     }
+
+    public function testGetCurlOptions()
+    {
+        $client = new Client('https://localhost:4010', null, null, null, [CURLOPT_PROXY => '127.0.0.1:8080']);
+        $this->assertSame([CURLOPT_PROXY => '127.0.0.1:8080'], $client->getCurlOptions());
+
+        $client = new Client('https://localhost:4010', null, null, null, null);
+        $this->assertSame([], $client->getCurlOptions());
+    }
 }