Merge pull request #49 from kbond/guzzle4-5

lsmith77 · lsmith77 · commit b855b48f6539 · 2014-12-07T19:10:07.000+01:00
Add support for guzzle 4/5
diff --git a/.travis.yml b/.travis.yml
@@ -13,6 +13,7 @@ php:
 
 before_install:
  - composer self-update
+ - if [[ "$TRAVIS_PHP_VERSION" != "5.3" && "$TRAVIS_PHP_VERSION" != "5.3.3" ]]; then composer require --no-update guzzlehttp/guzzle:~4; fi
  - composer install --prefer-source
  - wget http://cs.sensiolabs.org/get/php-cs-fixer.phar
 
diff --git a/src/ZendDiagnostics/Check/GuzzleHttpService.php b/src/ZendDiagnostics/Check/GuzzleHttpService.php
@@ -5,8 +5,10 @@
 
 namespace ZendDiagnostics\Check;
 
-use Guzzle\Http\Client;
-use Guzzle\Http\ClientInterface;
+use Guzzle\Http\Client as Guzzle3Client;
+use Guzzle\Http\ClientInterface as Guzzle3ClientInterface;
+use GuzzleHttp\Client as Guzzle4And5Client;
+use GuzzleHttp\ClientInterface as Guzzle4And5ClientInterface;
 use ZendDiagnostics\Result\Failure;
 use ZendDiagnostics\Result\Success;
 
@@ -21,27 +23,33 @@ class GuzzleHttpService extends AbstractCheck
     protected $guzzle;
 
     /**
-     * @param string          $url        The absolute url to check
-     * @param array           $headers    An array of headers used to create the request
-     * @param array           $options    An array of guzzle options used to create the request
-     * @param int             $statusCode The response status code to check
-     * @param null            $content    The response content to check
-     * @param ClientInterface $guzzle     Instance of guzzle to use
-     * @param string          $method     The method of the request
-     * @param mixed           $body       The body of the request (used for POST, PUT and DELETE requests)
+     * @param string                                 $url        The absolute url to check
+     * @param array                                  $headers    An array of headers used to create the request
+     * @param array                                  $options    An array of guzzle options used to create the request
+     * @param int                                    $statusCode The response status code to check
+     * @param null                                   $content    The response content to check
+     * @param \Guzzle\Http\Client|\GuzzleHttp\Client $guzzle     Instance of guzzle to use
+     * @param string                                 $method     The method of the request
+     * @param mixed                                  $body       The body of the request (used for POST, PUT and DELETE requests)
+     *
+     * @throws \InvalidArgumentException
      */
-    public function __construct($url, array $headers = array(), array $options = array(), $statusCode = 200, $content = null, ClientInterface $guzzle = null, $method = 'GET', $body = null)
+    public function __construct($url, array $headers = array(), array $options = array(), $statusCode = 200, $content = null, $guzzle = null, $method = 'GET', $body = null)
     {
         $this->url = $url;
         $this->headers = $headers;
         $this->options = $options;
-        $this->statusCode = $statusCode;
+        $this->statusCode = (int) $statusCode;
         $this->content = $content;
         $this->method = $method;
         $this->body = $body;
 
         if (!$guzzle) {
-            $guzzle = new Client();
+            $guzzle = $this->createGuzzleClient();
+        }
+
+        if ((!$guzzle instanceof Guzzle3ClientInterface) && (!$guzzle instanceof Guzzle4And5ClientInterface)) {
+            throw new \InvalidArgumentException('Parameter "guzzle" must be an instance of "\Guzzle\Http\ClientInterface" or "\GuzzleHttp\ClientInterface"');
         }
 
         $this->guzzle = $guzzle;
@@ -52,16 +60,97 @@ public function __construct($url, array $headers = array(), array $options = arr
      */
     public function check()
     {
-        $response = $this->guzzle->createRequest($this->method, $this->url, $this->headers, $this->body, $this->options)->send();
+        if ($this->guzzle instanceof Guzzle3ClientInterface) {
+            return $this->guzzle3Check();
+        }
+
+        return $this->guzzle4And5Check();
+    }
+
+    /**
+     * @return Failure|Success
+     */
+    private function guzzle3Check()
+    {
+        $response = $this->guzzle->createRequest(
+            $this->method,
+            $this->url,
+            $this->headers,
+            $this->body,
+            array_merge(array('exceptions' => false), $this->options)
+        )->send();
 
         if ($this->statusCode !== $statusCode = $response->getStatusCode()) {
-            return new Failure("Status code {$this->statusCode} does not match {$statusCode} in response from {$this->url}");
+            return $this->createStatusCodeFailure($statusCode);
         }
 
         if ($this->content && (false === strpos($response->getBody(true), $this->content))) {
-            return new Failure("Content {$this->content} not found in response from {$this->url}");
+            return $this->createContentFailure();
+        }
+
+        return new Success();
+    }
+
+    /**
+     * @return Failure|Success
+     */
+    private function guzzle4And5Check()
+    {
+        $request = $this->guzzle->createRequest(
+            $this->method,
+            $this->url,
+            array_merge(
+                array('headers' => $this->headers, 'body' => $this->body, 'exceptions' => false),
+                $this->options
+            )
+        );
+
+        $response = $this->guzzle->send($request);
+
+        if ($this->statusCode !== $statusCode = (int) $response->getStatusCode()) {
+            return $this->createStatusCodeFailure($statusCode);
+        }
+
+        if ($this->content && (false === strpos((string) $response->getBody(), $this->content))) {
+            return $this->createContentFailure();
         }
 
         return new Success();
     }
+
+    /**
+     * @param int $statusCode
+     *
+     * @return Failure
+     */
+    private function createStatusCodeFailure($statusCode)
+    {
+        return new Failure("Status code {$this->statusCode} does not match {$statusCode} in response from {$this->url}");
+    }
+
+    /**
+     * @return Failure
+     */
+    private function createContentFailure()
+    {
+        return new Failure("Content {$this->content} not found in response from {$this->url}");
+    }
+
+    /**
+     * @return \Guzzle\Http\Client|\GuzzleHttp\Client
+     *
+     * @throws \Exception
+     */
+    private function createGuzzleClient()
+    {
+        if (class_exists('GuzzleHttp\Client')) {
+            return new Guzzle4And5Client();
+        }
+
+        if (!class_exists('Guzzle\Http\Client')) {
+            throw new \Exception('Guzzle is required.');
+        }
+
+        return new Guzzle3Client();
+    }
 }
diff --git a/tests/ZendDiagnosticsTest/GuzzleHttpServiceTest.php b/tests/ZendDiagnosticsTest/GuzzleHttpServiceTest.php
@@ -2,25 +2,29 @@
 
 namespace ZendDiagnosticsTest;
 
-use Guzzle\Http\Client;
-use Guzzle\Http\Message\Response;
+use Guzzle\Http\Client as Guzzle3Client;
+use Guzzle\Http\Message\Response as Guzzle3Response;
+use GuzzleHttp\Client as Guzzle4And5Client;
+use GuzzleHttp\Message\Response as Guzzle4And5Response;
 use Guzzle\Plugin\Mock\MockPlugin;
+use GuzzleHttp\Stream\Stream;
+use GuzzleHttp\Subscriber\Mock;
 use ZendDiagnostics\Check\GuzzleHttpService;
 
 class GuzzleHttpServiceTest extends \PHPUnit_Framework_TestCase
 {
     /**
      * @dataProvider checkProvider
      */
-    public function testCheck($content, $actualContent, $actualStatusCode, $resultClass, $method = 'GET', $body = null)
+    public function testGuzzle3Check($content, $actualContent, $actualStatusCode, $resultClass, $method = 'GET', $body = null)
     {
         $check = new GuzzleHttpService(
             'http://www.example.com/foobar',
             array(),
             array(),
-            200,
+            '200',
             $content,
-            $this->getMockClient($actualStatusCode, $actualContent),
+            $this->getMockGuzzle3Client($actualStatusCode, $actualContent),
             $method,
             $body
         );
@@ -29,6 +33,38 @@ public function testCheck($content, $actualContent, $actualStatusCode, $resultCl
         $this->assertInstanceOf($resultClass, $result);
     }
 
+    /**
+     * @dataProvider checkProvider
+     */
+    public function testGuzzle4And5Check($content, $actualContent, $actualStatusCode, $resultClass, $method = 'GET', $body = null)
+    {
+        if (!class_exists('GuzzleHttp\Client')) {
+            $this->markTestSkipped('guzzlehttp/guzzle not installed.');
+        }
+
+        $check = new GuzzleHttpService(
+            'http://www.example.com/foobar',
+            array(),
+            array(),
+            '200',
+            $content,
+            $this->getMockGuzzle4And5Client($actualStatusCode, $actualContent),
+            $method,
+            $body
+        );
+        $result = $check->check();
+
+        $this->assertInstanceOf($resultClass, $result);
+    }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     */
+    public function testInvalidClient()
+    {
+        $check = new GuzzleHttpService('http://example.com', array(), array(), 200, null, 'not guzzle');
+    }
+
     public function checkProvider()
     {
         return array(
@@ -44,21 +80,26 @@ public function checkProvider()
             array('baz', 'foobar', 200, 'ZendDiagnostics\Result\FailureInterface'),
             array('baz', 'foobar', 200, 'ZendDiagnostics\Result\FailureInterface', 'POST', array('key' => 'value')),
             array('baz', 'foobar', 200, 'ZendDiagnostics\Result\FailureInterface', 'PUT'),
+            array('baz', 'foobar', 500, 'ZendDiagnostics\Result\FailureInterface'),
         );
     }
 
-    private function getMockClient($statusCode = 200, $content = null)
+    private function getMockGuzzle3Client($statusCode = 200, $content = null)
     {
         $plugin = new MockPlugin();
-        $plugin->addResponse(new Response($statusCode, null, $content));
+        $plugin->addResponse(new Guzzle3Response($statusCode, null, $content));
 
-        $client = new Client(null, array(
-            'request.options' => array(
-                'exceptions' => false
-            )
-        ));
+        $client = new Guzzle3Client();
         $client->addSubscriber($plugin);
 
         return $client;
     }
+
+    private function getMockGuzzle4And5Client($statusCode = 200, $content = null)
+    {
+        $client = new Guzzle4And5Client();
+        $client->getEmitter()->attach(new Mock(array(new Guzzle4And5Response($statusCode, array(), Stream::factory((string) $content)))));
+
+        return $client;
+    }
 }
