Lucianocn master (#232)

* improved .gitignore

* added extraGuzzleRequestsOptions (optional) to IntercomClient

* avoid $extraGuzzleRequestsOptions errors

* typo fixes

* Adding unit test for PR #206 and fixing unit test from previous PR

* Removing misc print and setting test timezone to UTC

* Fixing issue with CI test failing

Author: choran

.gitignore

@@ -1,5 +1,17 @@
-build/
-composer.lock
-vendor/*
-*.swp
+# OSX
+.DS_Store
+
+# PhpStorm
+.idea
+
+# Composer
 composer.phar
+/vendor
+
+# PhpUnit
+phpunit.phar
+/phpunit.xml
+
+# Extras
+build/
+*.swp

src/IntercomClient.php

@@ -18,6 +18,9 @@ class IntercomClient
     /** @var string API password authentication */
     protected $passwordPart;
 
+    /** @var string Extra Guzzle Requests Options */
+    protected $extraGuzzleRequestsOptions;
+
     /** @var IntercomUsers $users */
     public $users;
 
@@ -62,7 +65,7 @@ class IntercomClient
      * @param string $usernamePart App ID.
      * @param string $passwordPart Api Key.
      */
-    public function __construct($usernamePart, $passwordPart)
+    public function __construct($usernamePart, $passwordPart, $extraGuzzleRequestsOptions = [])
     {
         $this->setDefaultClient();
         $this->users = new IntercomUsers($this);
@@ -81,6 +84,7 @@ public function __construct($usernamePart, $passwordPart)
 
         $this->usernamePart = $usernamePart;
         $this->passwordPart = $passwordPart;
+        $this->extraGuzzleRequestsOptions = $extraGuzzleRequestsOptions;
     }
 
     private function setDefaultClient()
@@ -106,13 +110,14 @@ public function setClient($client)
      */
     public function post($endpoint, $json)
     {
-        $response = $this->http_client->request('POST', "https://api.intercom.io/$endpoint", [
+        $guzzleRequestOptions = $this->getGuzzleRequestOptions([
             'json' => $json,
             'auth' => $this->getAuth(),
             'headers' => [
                 'Accept' => 'application/json'
-            ]
+            ],
         ]);
+        $response = $this->http_client->request('POST', "https://api.intercom.io/$endpoint", $guzzleRequestOptions);
         return $this->handleResponse($response);
     }
 
@@ -125,13 +130,15 @@ public function post($endpoint, $json)
      */
     public function put($endpoint, $json)
     {
-        $response = $this->http_client->request('PUT', "https://api.intercom.io/$endpoint", [
+        $guzzleRequestOptions = $this->getGuzzleRequestOptions([
             'json' => $json,
             'auth' => $this->getAuth(),
             'headers' => [
                 'Accept' => 'application/json'
-            ]
+            ],
         ]);
+
+        $response = $this->http_client->request('PUT', "https://api.intercom.io/$endpoint", $guzzleRequestOptions);
         return $this->handleResponse($response);
     }
 
@@ -144,13 +151,15 @@ public function put($endpoint, $json)
      */
     public function delete($endpoint, $json)
     {
-        $response = $this->http_client->request('DELETE', "https://api.intercom.io/$endpoint", [
+        $guzzleRequestOptions = $this->getGuzzleRequestOptions([
             'json' => $json,
             'auth' => $this->getAuth(),
             'headers' => [
                 'Accept' => 'application/json'
-            ]
+            ],
         ]);
+
+        $response = $this->http_client->request('DELETE', "https://api.intercom.io/$endpoint", $guzzleRequestOptions);
         return $this->handleResponse($response);
     }
 
@@ -162,13 +171,15 @@ public function delete($endpoint, $json)
      */
     public function get($endpoint, $query)
     {
-        $response = $this->http_client->request('GET', "https://api.intercom.io/$endpoint", [
+        $guzzleRequestOptions = $this->getGuzzleRequestOptions([
             'query' => $query,
             'auth' => $this->getAuth(),
             'headers' => [
                 'Accept' => 'application/json'
-            ]
+            ],
         ]);
+
+        $response = $this->http_client->request('GET', "https://api.intercom.io/$endpoint", $guzzleRequestOptions);
         return $this->handleResponse($response);
     }
 
@@ -180,15 +191,27 @@ public function get($endpoint, $query)
      */
     public function nextPage($pages)
     {
-        $response = $this->http_client->request('GET', $pages->next, [
+        $guzzleRequestOptions = $this->getGuzzleRequestOptions([
             'auth' => $this->getAuth(),
             'headers' => [
                 'Accept' => 'application/json'
-            ]
+            ],
         ]);
+
+        $response = $this->http_client->request('GET', $pages->next, $guzzleRequestOptions);
         return $this->handleResponse($response);
     }
 
+    /**
+     * Returns Guzzle Requests Options Array
+     * @param  array $defaultGuzzleRequestsOptions
+     * @return array
+     */
+    public function getGuzzleRequestOptions($defaultGuzzleRequestOptions = [])
+    {
+        return array_replace_recursive($this->extraGuzzleRequestsOptions, $defaultGuzzleRequestOptions);
+    }
+
     /**
      * Returns authentication parameters.
      * @return array

test/IntercomClientTest.php

@@ -34,6 +34,33 @@ public function testBasicClient()
     }
   }
 
+  public function testExtendedClient()
+  {
+    $mock = new MockHandler([
+        new Response(200, ['X-Foo' => 'Bar'], "{\"foo\":\"bar\"}")
+    ]);
+
+    $container = [];
+    $history = Middleware::history($container);
+    $stack = HandlerStack::create($mock);
+    $stack->push($history);
+
+    $http_client = new Client(['handler' => $stack]);
+
+    $client = new IntercomClient('u', 'p', ['connect_timeout' => 10]);
+    $client->setClient($http_client);
+
+    $client->users->create([
+        'email' => '[email protected]'
+    ]);
+
+    foreach ($container as $transaction) {
+      $basic = $client->getGuzzleRequestOptions()['connect_timeout'];
+      $this->assertTrue($basic == 10);
+    }
+  }
+
+
   public function testPaginationHelper()
   {
     $mock = new MockHandler([
@@ -63,6 +90,7 @@ public function testPaginationHelper()
 
   public function testRateLimitDetails()
   {
+    date_default_timezone_set('UTC');
     $time = time() + 7;
     $mock = new MockHandler([
         new Response(200, ['X-RateLimit-Limit' => '83', 'X-RateLimit-Remaining' => '2', 'X-RateLimit-Reset' => $time], "{\"foo\":\"bar\"}")