Merge pull request #26 from andrzejwaw/SKYHELIX-653

SKYHELIX-653 | Metrics interface and request proxy decorator

src/Toper/Client.php

@@ -15,15 +15,31 @@ class Client implements ClientInterface
     private $guzzleClientFactory;
 
     /**
-     * @param HostPoolProviderInterface    $hostPoolProvider
-     * @param GuzzleClientFactoryInterface $guzzleClientFactory
+     * @var MetricsInterface
+     */
+    private $metrics;
+
+    /**
+     * @var ProxyDecoratorInterface
+     */
+    private $proxyDecorator;
+
+    /**
+     * @param HostPoolProviderInterface     $hostPoolProvider
+     * @param GuzzleClientFactoryInterface  $guzzleClientFactory
+     * @param MetricsInterface|null         $metrics
+     * @param ProxyDecoratorInterface       $proxyDecorator
      */
     public function __construct(
         HostPoolProviderInterface $hostPoolProvider,
-        GuzzleClientFactoryInterface $guzzleClientFactory
+        GuzzleClientFactoryInterface $guzzleClientFactory,
+        MetricsInterface $metrics = null,
+        ProxyDecoratorInterface $proxyDecorator = null
     ) {
         $this->hostPoolProvider = $hostPoolProvider;
         $this->guzzleClientFactory = $guzzleClientFactory;
+        $this->metrics = $metrics;
+        $this->proxyDecorator = $proxyDecorator;
     }
 
     /**
@@ -39,7 +55,9 @@ public function get($url, array $binds = array())
             $url,
             $binds,
             $this->hostPoolProvider->get(),
-            $this->guzzleClientFactory->create()
+            $this->guzzleClientFactory->create(),
+            $this->metrics,
+            $this->proxyDecorator
         );
     }
 
@@ -56,7 +74,9 @@ public function post($url, array $binds = array())
             $url,
             $binds,
             $this->hostPoolProvider->get(),
-            $this->guzzleClientFactory->create()
+            $this->guzzleClientFactory->create(),
+            $this->metrics,
+            $this->proxyDecorator
         );
     }
 
@@ -73,7 +93,9 @@ public function patch($url, array $binds = array())
             $url,
             $binds,
             $this->hostPoolProvider->get(),
-            $this->guzzleClientFactory->create()
+            $this->guzzleClientFactory->create(),
+            $this->metrics,
+            $this->proxyDecorator
         );
     }
 
@@ -90,7 +112,9 @@ public function put($url, array $binds = array())
             $url,
             $binds,
             $this->hostPoolProvider->get(),
-            $this->guzzleClientFactory->create()
+            $this->guzzleClientFactory->create(),
+            $this->metrics,
+            $this->proxyDecorator
         );
     }
 
@@ -107,7 +131,9 @@ public function delete($url, array $binds = array())
             $url,
             $binds,
             $this->hostPoolProvider->get(),
-            $this->guzzleClientFactory->create()
+            $this->guzzleClientFactory->create(),
+            $this->metrics,
+            $this->proxyDecorator
         );
     }
 }

src/Toper/MetricsInterface.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Toper;
+
+interface MetricsInterface
+{
+    public function increment($method, $url);
+}

src/Toper/ProxyDecoratorInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Toper;
+
+use Guzzle\Http\Message\Request as GuzzleRequest;
+
+interface ProxyDecoratorInterface
+{
+    /**
+     * @return string
+     */
+    public function getBaseUrl();
+
+    /**
+     * @param GuzzleRequest $request
+     * @return string
+     */
+    public function decorate(GuzzleRequest $request);
+}

src/Toper/Request.php

@@ -61,24 +61,40 @@ class Request
     private $headers = array();
 
     /**
-     * @param string                $method
-     * @param string                $url
-     * @param array                 $binds
-     * @param HostPoolInterface     $hostPool
-     * @param GuzzleClientInterface $guzzleClient
+     * @var MetricsInterface
+     */
+    private $metrics;
+
+    /**
+     * @var ProxyDecoratorInterface
+     */
+    private $proxyDecorator;
+
+    /**
+     * @param string                  $method
+     * @param string                  $url
+     * @param array                   $binds
+     * @param HostPoolInterface       $hostPool
+     * @param GuzzleClientInterface   $guzzleClient
+     * @param MetricsInterface        $metrics
+     * @param ProxyDecoratorInterface $proxyDecorator
      */
     public function __construct(
         $method,
         $url,
         array $binds,
         HostPoolInterface $hostPool,
-        GuzzleClientInterface $guzzleClient
+        GuzzleClientInterface $guzzleClient,
+        MetricsInterface $metrics = null,
+        ProxyDecoratorInterface $proxyDecorator = null
     ) {
         $this->method = $method;
         $this->url = $url;
         $this->binds = $binds;
         $this->hostPool = $hostPool;
         $this->guzzleClient = $guzzleClient;
+        $this->metrics = $metrics;
+        $this->proxyDecorator = $proxyDecorator;
     }
 
     /**
@@ -142,6 +158,13 @@ public function send()
 
                 $this->updateQueryParams($guzzleRequest);
 
+                if (!is_null($this->proxyDecorator)) {
+                    $this->proxyDecorator->decorate($guzzleRequest);
+                }
+                if (!is_null($this->metrics)) {
+                    $this->metrics->increment($this->method, $this->url);
+                }
+
                 return new Response($guzzleRequest->send());
             } catch (ClientErrorResponseException $e) {
                 return new Response($e->getResponse());

tests/unit/Toper/RequestTest.php

@@ -53,6 +53,43 @@ public function shouldSendRequest()
         $this->assertEquals($guzzleResponse->getBody(true), $response->getBody());
     }
 
+    /**
+     * @test
+     */
+    public function shouldSendMetricsAndDecorateRequestBeforeSend()
+    {
+        $guzzleClient = $this->createGuzzleClientMock();
+
+        $guzzleResponse = new GuzzleResponse(200, array(), 'ok');
+
+        $guzzleRequest = $this->createGuzzleRequest($guzzleResponse);
+
+        $this->prepareGuzzleClientMock($guzzleClient, $guzzleRequest);
+
+        $this->returnValue($guzzleResponse);
+
+        $metricsInterfaceMock = $this->getMock('Toper\MetricsInterface', array('increment'));
+        $metricsInterfaceMock->expects($this->once())->method('increment');
+
+        $proxyDecoratorInterfaceMock = $this->getMock(
+            'Toper\ProxyDecoratorInterface',
+            array('decorate', 'getBaseUrl')
+        );
+        $proxyDecoratorInterfaceMock->expects($this->once())->method('decorate');
+
+        $instance = $this->createInstance(
+            Request::GET,
+            array(),
+            $guzzleClient,
+            $metricsInterfaceMock,
+            $proxyDecoratorInterfaceMock
+        );
+        $response = $instance->send();
+
+        $this->assertEquals($guzzleResponse->getStatusCode(), $response->getStatusCode());
+        $this->assertEquals($guzzleResponse->getBody(true), $response->getBody());
+    }
+
     /**
      * @test
      */
@@ -376,19 +413,26 @@ public function shouldReturnBinds()
      * @param array $binds
      * @param GuzzleClientInterface $guzzleClient
      *
+     * @param null $metrics
+     * @param null $proxyDecorator
      * @return Request
      */
     private function createInstance(
         $method,
         array $binds,
-        GuzzleClientInterface $guzzleClient
+        GuzzleClientInterface $guzzleClient,
+        $metrics = null,
+        $proxyDecorator = null
     ) {
+
         return new Request(
             $method,
             self::URL,
             $binds,
             $this->hostPool,
-            $guzzleClient
+            $guzzleClient,
+            $metrics,
+            $proxyDecorator
         );
     }