Merge pull request #31 from kbond/guzzle-http-service

added GuzzleHttpService Check

Author: Thinkscape

README.md

@@ -17,6 +17,7 @@ It currently ships with the following Diagnostic Checks:
  * [DiskFree](#diskfree) - check there's enough free space on given path,
  * [ExtensionLoaded](#extensionloaded) - make sure extension is loaded,
  * [HttpService](#httpservice) - check if given http host is responding,
+ * [GuzzleHttpService](#guzzlehttpservice) - check if given http host is responding using Guzzle,
  * [Memcache](#memcache) - check if memcache extension is loaded and given server is reachable,
  * [PhpVersion](#phpversion) - make sure that PHP version matches constraint,
  * [PhpFlag](#phpflag) - make sure that given PHP flag (feature) is turned on or off.
@@ -418,6 +419,35 @@ $checkPageContent = new HttpService(
 );
 ````
 
+### GuzzleHttpService
+
+Attempt connection to given HTTP host or IP address and try to load a web page using
+[Guzzle](http://guzzle3.readthedocs.org/en/latest/). The check also supports checking response
+codes and page contents.
+
+````php
+<?php
+use ZendDiagnostics\Check\GuzzleHttpService;
+
+// Try to connect to google.com
+$checkGoogle = new GuzzleHttpService('www.google.com');
+
+// Check port 8080 on localhost
+$checkLocal = new GuzzleHttpService('127.0.0.1:8080');
+
+// Check that the page exists (response code must equal 200)
+$checkPage = new GuzzleHttpService('www.example.com/some/page.html');
+
+// Check page content
+$checkPageContent = new GuzzleHttpService(
+    'www.example.com/some/page.html',
+    array(),
+    array(),
+    200,
+    '<title>Hello World</title>'
+);
+````
+
 ### Memcache
 
 Attempt to connect to given Memcache server.

composer.json

@@ -20,12 +20,15 @@
     "require-dev": {
         "zendframework/zend-loader"  : "2.*",
         "sensiolabs/security-checker": "1.3.*@dev",
-        "symfony/yaml": "v2.3.11"
+        "symfony/yaml": "v2.3.11",
+        "guzzle/http"                : "3.*",
+        "guzzle/plugin-mock"         : "3.*"
     },
     "suggest" : {
         "ext-bcmath" : "Required by Check\\CpuPerformance",
         "sensiolabs/security-checker": "Required by Check\\SecurityAdvisory",
-        "symfony/yaml": "Required by Check\\YamlFile"
+        "symfony/yaml": "Required by Check\\YamlFile",
+        "guzzle/http": "Required by Check\\GuzzleHttpService"
     },
     "extra": {
         "branch-alias": {

src/ZendDiagnostics/Check/GuzzleHttpService.php

@@ -0,0 +1,61 @@
+<?php
+/**
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace ZendDiagnostics\Check;
+
+use Guzzle\Http\Client;
+use Guzzle\Http\ClientInterface;
+use ZendDiagnostics\Result\Failure;
+use ZendDiagnostics\Result\Success;
+
+class GuzzleHttpService extends AbstractCheck
+{
+    protected $url;
+    protected $headers;
+    protected $statusCode;
+    protected $content;
+    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
+     */
+    public function __construct($url, array $headers = array(), array $options = array(), $statusCode = 200, $content = null, ClientInterface $guzzle = null)
+    {
+        $this->url = $url;
+        $this->headers = $headers;
+        $this->options = $options;
+        $this->statusCode = $statusCode;
+        $this->content = $content;
+
+        if (!$guzzle) {
+            $guzzle = new Client();
+        }
+
+        $this->guzzle = $guzzle;
+    }
+
+    /**
+     * @see ZendDiagnostics\CheckInterface::check()
+     */
+    public function check()
+    {
+        $response = $this->guzzle->get($this->url, $this->headers, $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}");
+        }
+
+        if ($this->content && (false === strpos($response->getBody(true), $this->content))) {
+            return new Failure("Content {$this->content} not found in response from {$this->url}");
+        }
+
+        return new Success();
+    }
+}

tests/ZendDiagnosticsTest/GuzzleHttpServiceTest.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace ZendDiagnosticsTest;
+
+use Guzzle\Http\Client;
+use Guzzle\Http\Message\Response;
+use Guzzle\Plugin\Mock\MockPlugin;
+use ZendDiagnostics\Check\GuzzleHttpService;
+
+class GuzzleHttpServiceTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @dataProvider checkProvider
+     */
+    public function testCheck($content, $actualContent, $actualStatusCode, $resultClass)
+    {
+        $check = new GuzzleHttpService(
+            'http://www.example.com/foobar',
+            array(),
+            array(),
+            200,
+            $content,
+            $this->getMockClient($actualStatusCode, $actualContent)
+        );
+        $result = $check->check();
+
+        $this->assertInstanceOf($resultClass, $result);
+    }
+
+    public function checkProvider()
+    {
+        return array(
+            array(null, null, 200, 'ZendDiagnostics\Result\SuccessInterface'),
+            array(null, null, 404, 'ZendDiagnostics\Result\FailureInterface'),
+            array('foo', 'foobar', 200, 'ZendDiagnostics\Result\SuccessInterface'),
+            array('baz', 'foobar', 200, 'ZendDiagnostics\Result\FailureInterface')
+        );
+    }
+
+    private function getMockClient($statusCode = 200, $content = null)
+    {
+        $plugin = new MockPlugin();
+        $plugin->addResponse(new Response($statusCode, null, $content));
+
+        $client = new Client(null, array(
+            'request.options' => array(
+                'exceptions' => false
+            )
+        ));
+        $client->addSubscriber($plugin);
+
+        return $client;
+    }
+}