Add caching support

Author: ivan770

src/Exceptions/Cache/BrowserKitCache.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Ivan770\HttpClient\Exceptions\Cache;
+
+use Exception;
+
+class BrowserKitCache extends Exception
+{
+    protected $message = "BrowserKit caching is not supported";
+
+    public function __toString() {
+        return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
+    }
+}

src/Exceptions/Cache/NullRepository.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Ivan770\HttpClient\Exceptions\Cache;
+
+use Exception;
+
+class NullRepository extends Exception
+{
+    protected $message = "Cache repository was not provided";
+
+    public function __toString() {
+        return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
+    }
+}

src/Request/Request.php

@@ -3,11 +3,15 @@
 
 namespace Ivan770\HttpClient\Request;
 
+use Illuminate\Contracts\Cache\Repository;
 use Illuminate\Contracts\Support\Arrayable;
 use Illuminate\Support\Collection;
 use Ivan770\HttpClient\Contracts\PassToBrowserKit;
 use Ivan770\HttpClient\Contracts\Request as RequestContract;
+use Ivan770\HttpClient\Exceptions\Cache\BrowserKitCache;
+use Ivan770\HttpClient\Exceptions\Cache\NullRepository;
 use Ivan770\HttpClient\HttpClient;
+use Ivan770\HttpClient\Response\Response;
 use Symfony\Component\BrowserKit\CookieJar;
 use Symfony\Component\BrowserKit\History;
 use Symfony\Component\DomCrawler\Crawler;
@@ -35,6 +39,13 @@ abstract class Request extends BrowserKitRequest implements RequestContract
      */
     protected $client;
 
+    /**
+     * Cache repository instance
+     *
+     * @var Repository
+     */
+    protected $repository;
+
     /**
      * Request URL
      *
@@ -49,12 +60,21 @@ abstract class Request extends BrowserKitRequest implements RequestContract
      */
     protected $method = 'GET';
 
+    /**
+     * Request cache key
+     *
+     * @var mixed
+     */
+    protected $cacheKey;
+
     /**
      * @param HttpClient $client
+     * @param Repository|null $repository
      */
-    public function __construct(HttpClient $client)
+    public function __construct(HttpClient $client, Repository $repository = null)
     {
         $this->client = $client;
+        $this->repository = $repository;
 
         $this->defaultAttach($this->client);
     }
@@ -113,6 +133,16 @@ public function getResource()
         return $this->resource;
     }
 
+    /**
+     * Cache key getter
+     *
+     * @return mixed
+     */
+    public function getCacheKey()
+    {
+        return $this->cacheKey;
+    }
+
     /**
      * Attach builder properties. HttpClient instance is passed into Closure
      *
@@ -140,7 +170,7 @@ public function mock($test)
     /**
      * Run request
      *
-     * @return \Ivan770\HttpClient\Response\Response|Crawler
+     * @return Response|Crawler
      */
     public function execute()
     {
@@ -168,6 +198,29 @@ public function get()
         return $this->execute()->getContent();
     }
 
+    /**
+     * Get cached response, or run request and save response contents to cache
+     *
+     * @param $ttl
+     * @return mixed
+     * @throws BrowserKitCache
+     * @throws NullRepository
+     */
+    public function remember($ttl)
+    {
+        if($this->browserKit()) {
+            throw new BrowserKitCache();
+        }
+
+        if($this->repository === null) {
+            throw new NullRepository();
+        }
+
+        return $this->repository->remember($this->getCacheKey(), $ttl, function () {
+            return $this->get();
+        });
+    }
+
     public function __call($name, $arguments)
     {
         $this->client->$name(...$arguments);