Move common logic to the abstract client class, fix non-throwing of 400s in error handler

Author: dannyfallon

src/intercom/IntercomAbstractClient.php

@@ -3,7 +3,11 @@
 
 use InvalidArgumentException;
 use Guzzle\Service\Client;
+use Guzzle\Common\Event;
+use Guzzle\Http\Message\Request;
 use Guzzle\Service\Description\ServiceDescription;
+use Intercom\Exception\IntercomException;
+use Guzzle\Common\Collection;
 
 abstract class IntercomAbstractClient extends Client
 {
@@ -13,14 +17,25 @@ abstract class IntercomAbstractClient extends Client
     /** @var string */
     const DEFAULT_ACCEPT_HEADER = 'application/vnd.intercom.3+json';
 
+    /**
+     * Configures the client by setting the appropriate headers, service description and error handling
+     *
+     * @param Collection $config
+     */
+    protected function configure($config) {
+        $this->setDefaultOption('headers', $config->get('headers'));
+        $this->setDescription($this->getServiceDescriptionFromFile($config->get('service_description')));
+        $this->setErrorHandler();
+    }
+
     /**
      * Loads the service description from the service description file
      *
      * @param string $description_file The service description file
      * @return ServiceDescription
      * @throws InvalidArgumentException If the description file doesn't exist or cannot be read
      */
-    public function getServiceDescriptionFromFile($description_file)
+    private function getServiceDescriptionFromFile($description_file)
     {
         if (!file_exists($description_file) || !is_readable($description_file)) {
             throw new InvalidArgumentException('Unable to read API definition schema');
@@ -29,6 +44,62 @@ public function getServiceDescriptionFromFile($description_file)
         return ServiceDescription::factory($description_file);
     }
 
+    /**
+     * Overrides the error handling in Guzzle so that when errors are encountered we throw
+     * Intercom errors, not Guzzle ones.
+     *
+     */
+    private function setErrorHandler()
+    {
+        $this->getEventDispatcher()->addListener(
+            'request.error',
+            function (Event $event) {
+                // Stop other events from firing when you override 401 responses
+                $event->stopPropagation();
+
+                if ($event['response']->getStatusCode() >= 400 && $event['response']->getStatusCode() < 600) {
+                    $e = IntercomException::factory($event['request'], $event['response']);
+                    $event['request']->setState(Request::STATE_ERROR, array('exception' => $e) + $event->toArray());
+                    throw $e;
+                }
+            }
+        );
+    }
+
+    /**
+     * Sets the username and password for basic auth on the client
+     *
+     * @param string $user
+     * @param string $password
+     */
+    public function setBasicAuth($user, $password)
+    {
+        $this->setDefaultOption(
+            'auth',
+            [
+                $user,
+                $password,
+                'Basic'
+            ]
+        );
+    }
+
+    /**
+     * Gets the default configuration options for the client
+     *
+     * @return array
+     */
+    public static function getDefaultConfig()
+    {
+        return [
+            'service_description' => __DIR__ . '/Service/config/intercom.json',
+            'headers' => [
+                'Content-Type' => self::DEFAULT_CONTENT_TYPE,
+                'Accept' => self::DEFAULT_ACCEPT_HEADER
+            ]
+        ];
+    }
+
     /**
      * A wrapper around two API calls to emulate the ping call from the other APIs
      *
@@ -37,7 +108,7 @@ public function getServiceDescriptionFromFile($description_file)
      */
     public function ping($user_details)
     {
-        $user = $this->saveUser($user_details);
+        $this->saveUser($user_details);
         return $this->getUnreadUserConversations($user_details);
     }
 }

src/intercom/IntercomBasicAuthClient.php

@@ -2,59 +2,33 @@
 namespace Intercom;
 
 use Guzzle\Common\Collection;
-use Guzzle\Common\Event;
 use Guzzle\Service\Client;
-use Guzzle\Http\Message\Request;
-use Intercom\Exception\IntercomException;
-
 
 class IntercomBasicAuthClient extends IntercomAbstractClient
 {
     /** @var array The required config variables for this type of client */
-    private static $required = ['app_id', 'api_key', 'headers', 'service_description'];
+    private static $required = [
+        'app_id',
+        'api_key',
+        'headers',
+        'service_description'
+    ];
 
     /**
-     * Creates a Basic Auth Client with the supplied configuration options
+     * Creates a basic auth client with the supplied configuration options
      *
      * @param array $config
      * @return Client|IntercomBasicAuthClient
      */
     public static function factory($config = [])
     {
-        $default = [
-            'service_description' => __DIR__ . '/Service/config/intercom.json',
-            'headers' => [
-                'Content-Type' => self::DEFAULT_CONTENT_TYPE,
-                'Accept' => self::DEFAULT_ACCEPT_HEADER
-            ]
-        ];
-
-        $config = Collection::fromConfig($config, $default, static::$required);
         $client = new self();
 
-        $client->setDefaultOption('headers', $config->get('headers'));
-
-        $client->setDefaultOption(
-            'auth',
-            [
-                $config->get('app_id'),
-                $config->get('api_key'),
-                'Basic'
-            ]
-        );
-
-        $client->setDescription(static::getServiceDescriptionFromFile($config->get('service_description')));
-
-        $client->getEventDispatcher()->addListener('request.error', function(Event $event) {
-            // Stop other events from firing when you override 401 responses
-            $event->stopPropagation();
-
-            if ($event['response']->getStatusCode() > 400 && $event['response']->getStatusCode() < 600) {
-                $e = IntercomException::factory($event['request'], $event['response']);
-                $event['request']->setState(Request::STATE_ERROR, array('exception' => $e) + $event->toArray());
-                throw $e;
-            }
-        });
+        $config = Collection::fromConfig($config, $client->getDefaultConfig(), static::$required);
+
+        $client->configure($config);
+
+        $client->setBasicAuth($config->get('app_id'), $config->get('api_key'));
 
         return $client;
     }