Merge pull request #49 from marcus-campos/fix/refactoring

Fix/refactoring

Author: marcus-campos

src/Cache/Cache.php

@@ -0,0 +1,99 @@
+<?php
+/**
+ * User: marcus-campos
+ * Date: 24/10/17
+ * Time: 12:33
+ */
+
+namespace Maestro\Cache;
+
+use Maestro\Exceptions\PostCachingException;
+
+trait Cache
+{
+    use CachingGetters;
+
+    /**
+     * {number} Time responses will be cached for (if caching is enabled).
+     */
+    protected $cacheTime = 60;
+
+    /**
+     * {string} Used by APCu.
+     */
+    private $cacheKey = '';
+
+    /**
+     * {boolean} Indicates if caching is turned on.
+     */
+    protected $cachingEnabled = false;
+
+    /**
+     * Turns on caching of response body for given time.
+     *
+     * @param int $time - Shelf-life of cached response in seconds
+     *
+     * @throws \Maestro\Exceptions\PostCachingException
+     *
+     * @return $this
+     */
+    public function cachable(int $time = 60)
+    {
+        if ($this->method === 'POST') {
+            throw new PostCachingException();
+        }
+        $this->cachingEnabled = true;
+        $this->cacheTime = $time;
+
+        return $this;
+    }
+
+    /**
+     * @throws \Maestro\Exceptions\NoUrlException
+     * @throws \Maestro\Exceptions\NoMethodException
+     *
+     * @return mixed
+     */
+    private function fetchCachedIfExists()
+    {
+        // Generate a key to use for caching
+        $this->cacheKey = md5($this->url . $this->endPoint);
+
+        // Set the response from APCu cache
+        if (apcu_exists($this->cacheKey)) {
+            $batch = apcu_fetch($this->cacheKey);
+            // Check that expiry date is after now but also check that it is before our current cache time
+            // just incase a cache has been created by a previous request with a longer cache time.
+            if ($batch['expires'] > time() && $batch['expires'] < $this->makeCacheExpiryTime()) {
+                $this->responseBody = $batch['responseBody'];
+
+                return $this;
+            }
+        }
+
+        return $this->sendRequest();
+    }
+
+    /**
+     * @return int
+     */
+    private function makeCacheExpiryTime(): int
+    {
+        return time() + $this->cacheTime;
+    }
+
+    private function cacheResponseBody()
+    {
+        if (method_exists($this->response, 'getBody')) {
+            $this->responseBody = (string)$this->response->getBody();
+        }
+
+        if ($this->cachingEnabled && $this->response->getReasonPhrase() === 'OK') {
+            $batch = [
+                'expires' => $this->makeCacheExpiryTime(),
+                'responseBody' => $this->responseBody,
+            ];
+            apcu_store($this->cacheKey, $batch);
+        }
+    }
+}

src/CachingGetters.php renamed to src/Cache/CachingGetters.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Maestro;
+namespace Maestro\Cache;
 
 trait CachingGetters
 {

src/Rest.php

@@ -11,14 +11,14 @@
 use GuzzleHttp\Handler\CurlMultiHandler;
 use GuzzleHttp\HandlerStack;
 use GuzzleHttp\Psr7\Request;
+use Maestro\Cache\Cache;
 use Maestro\Exceptions\NoMethodException;
 use Maestro\Exceptions\NoUrlException;
-use Maestro\Exceptions\PostCachingException;
 use Maestro\Http\Methods;
 
 class Rest
 {
-    use Methods, CachingGetters;
+    use Methods, Cache;
 
     protected $url;
 
@@ -40,26 +40,11 @@ class Rest
      */
     private $client;
 
-    /**
-     * {boolean} Indicates if caching is turned on.
-     */
-    protected $cachingEnabled = false;
-
     /**
      * {string} The response body as a string to make it cachable.
      */
     protected $responseBody;
 
-    /**
-     * {number} Time responses will be cached for (if caching is enabled).
-     */
-    protected $cacheTime = 60;
-
-    /**
-     * {string} Used by APCu.
-     */
-    private $cacheKey = '';
-
     public function __construct($client = null)
     {
         $this->client = $client;
@@ -161,25 +146,6 @@ public function body(array $body)
         return $this;
     }
 
-    /**
-     * Turns on caching of response body for given time.
-     *
-     * @param int $time - Shelf-life of cached response in seconds
-     *
-     * @throws \Maestro\Exceptions\PostCachingException
-     *
-     * @return $this
-     */
-    public function cachable(int $time = 60)
-    {
-        if ($this->method === 'POST') {
-            throw new PostCachingException();
-        }
-        $this->cachingEnabled = true;
-        $this->cacheTime = $time;
-
-        return $this;
-    }
 
     /**
      * Either sends the request or fetches a cached response body dependent on if caching is enabled.
@@ -199,40 +165,6 @@ public function send()
         return $this->sendRequest();
     }
 
-    /**
-     * @throws \Maestro\Exceptions\NoUrlException
-     * @throws \Maestro\Exceptions\NoMethodException
-     *
-     * @return mixed
-     */
-    private function fetchCachedIfExists()
-    {
-        // Generate a key to use for caching
-        $this->cacheKey = md5($this->url.$this->endPoint);
-
-        // Set the response from APCu cache
-        if (apcu_exists($this->cacheKey)) {
-            $batch = apcu_fetch($this->cacheKey);
-            // Check that expiry date is after now but also check that it is before our current cache time
-            // just incase a cache has been created by a previous request with a longer cache time.
-            if ($batch['expires'] > time() && $batch['expires'] < $this->makeCacheExpiryTime()) {
-                $this->responseBody = $batch['responseBody'];
-
-                return $this;
-            }
-        }
-
-        return $this->sendRequest();
-    }
-
-    /**
-     * @return int
-     */
-    private function makeCacheExpiryTime() : int
-    {
-        return time() + $this->cacheTime;
-    }
-
     /**
      * Sends the request and caches the response is caching is enabled.
      *
@@ -251,14 +183,7 @@ private function sendRequest()
             throw new NoUrlException();
         }
 
-        // GET method doesn't send a BODY
-        $paramsToSend = [$this->method, $this->url.$this->endPoint, $this->headers];
-
-        if ($this->method !== 'GET') {
-            $paramsToSend[] = $this->body;
-        }
-
-        $request = new Request(...$paramsToSend);
+        $request = $this->newRequest();
 
         $this->response = $this->client->send($request);
 
@@ -267,21 +192,6 @@ private function sendRequest()
         return $this;
     }
 
-    private function cacheResponseBody()
-    {
-        if (method_exists($this->response, 'getBody')) {
-            $this->responseBody = (string) $this->response->getBody();
-        }
-
-        if ($this->cachingEnabled && $this->response->getReasonPhrase() === 'OK') {
-            $batch = [
-                'expires'      => $this->makeCacheExpiryTime(),
-                'responseBody' => $this->responseBody,
-            ];
-            apcu_store($this->cacheKey, $batch);
-        }
-    }
-
     /**
      * @return $this
      */
@@ -291,12 +201,7 @@ public function sendAsync()
         $handler = HandlerStack::create($curl);
         $this->setClient(new Client(['handler' => $handler]));
 
-        $request = new Request(
-            $this->method,
-            $this->url.$this->endPoint,
-            $this->headers,
-            $this->body
-        );
+        $request = $this->newRequest();
 
         $this->response = $this->client->sendAsync($request)->then(
             function ($response) {
@@ -309,6 +214,21 @@ function ($response) {
         return $this;
     }
 
+    /**
+     * @return Request
+     */
+    private function newRequest()
+    {
+        // GET method doesn't send a BODY
+        $paramsToSend = [$this->method, $this->url . $this->endPoint, $this->headers];
+
+        if ($this->method !== 'GET') {
+            $paramsToSend[] = $this->body;
+        }
+
+        return new Request(...$paramsToSend);
+    }
+
     /**
      * @return mixed
      */
@@ -320,7 +240,7 @@ public function getResponse()
     /**
      * @return int
      */
-    public function status() : int
+    public function status(): int
     {
         return $this->response->getStatusCode();
     }

tests/FakeResponse.php

@@ -16,7 +16,7 @@ public function getBody()
     {
         return $this->body;
     }
-    
+
     public function getStatusCode()
     {
         return 200;

tests/RestTest.php

@@ -188,8 +188,8 @@ public function testStatus()
     {
         $mock = \Mockery::mock(new Client());
         $mock->shouldReceive('send')
-             ->times(1)
-             ->andReturn(new FakeResponse());
+            ->times(1)
+            ->andReturn(new FakeResponse());
 
         $this->restClass = new Rest($mock);
 

tests/bootstrap.php

@@ -5,6 +5,6 @@
  * Add additional configuration/setup your application needs when running
  * unit tests in this file.
  */
-require_once dirname(__DIR__).DIRECTORY_SEPARATOR.'vendor/autoload.php';
+require_once dirname(__DIR__) . DIRECTORY_SEPARATOR . 'vendor/autoload.php';
 
 $_SERVER['PHP_SELF'] = '/';