Merge pull request #17 from dpdconnect/1.1.9

1.1.9

Author: dpdplugin

src/CacheWrapper.php

@@ -0,0 +1,79 @@
+<?php
+
+namespace DpdConnect\Sdk;
+
+use DpdConnect\Sdk\Resources\CacheInterface;
+
+class CacheWrapper
+{
+    /** @var CacheInterface|null */
+    public $cache;
+
+    /**
+     * @param CacheInterface|null $cache
+     */
+    public function __construct($cache = null)
+    {
+        $this->cache = $cache;
+    }
+
+    /**
+     * @param $key
+     * @param false $previous
+     * @param string $prefix
+     * @return false|mixed
+     */
+    public function getCachedList($key, $previous = false, $prefix = 'dpd')
+    {
+        // This is an hour
+        $maxAge = 3600;
+
+        if($previous) {
+            // This is a year;
+            $maxAge = 31556926;
+        }
+
+        // Check if implementation supports own caching
+        if($this->cache instanceof CacheInterface) {
+            return $this->cache->getCache($prefix .sha1(serialize($key)) . ($previous ? '_prev': ''));
+        }
+
+        // Fallback to SDK caching
+        $filename = sys_get_temp_dir().'/dpd/'.sha1($prefix . date('Ymd').serialize($key));
+
+        if (!file_exists($filename) || filesize($filename) == 0 || filemtime($filename) < time()-$maxAge) {
+            return false;
+        }
+
+        return unserialize(file_get_contents($filename));
+    }
+
+    /**
+     * @param $data
+     * @param $key
+     * @param string $prefix
+     */
+    public function storeCachedList($data, $key, $prefix = 'dpd')
+    {
+        // This is an hour
+        $hour = 3600;
+        // This is a year ;)
+        $year = 31556926;
+
+        // Check if implementation supports own caching
+        if($this->cache instanceof CacheInterface) {
+            $this->cache->setCache($prefix. sha1(serialize($key)), $data, $hour);
+            $this->cache->setCache($prefix .sha1(serialize($key)). '_prev', $data, $year);
+
+            return;
+        }
+
+        // Fallback to SDK caching
+        if (!file_exists(sys_get_temp_dir().'/dpd/')) {
+            mkdir(sys_get_temp_dir().'/dpd/');
+        }
+
+        $filename = sys_get_temp_dir().'/dpd/'.sha1($prefix.date('Ymd').serialize($key));
+        file_put_contents($filename, serialize($data));
+    }
+}

src/Client.php

@@ -5,6 +5,8 @@
 use DpdConnect\Sdk\Common\Authentication;
 use DpdConnect\Sdk\Common\HttpClient;
 use DpdConnect\Sdk\Common\ResourceClient;
+use DpdConnect\Sdk\Resources\CacheableInterface;
+use DpdConnect\Sdk\Resources\CacheInterface;
 use DpdConnect\Sdk\Resources\Country;
 use DpdConnect\Sdk\Resources\Job;
 use DpdConnect\Sdk\Resources\Parcel;
@@ -168,4 +170,16 @@ public function getToken()
     {
         return $this->token;
     }
+
+    /**
+     * @param CacheInterface|null $cache
+     */
+    public function setCacheCallable($cache)
+    {
+        foreach ($this as $prop) {
+            if($prop instanceof CacheableInterface) {
+                $prop->setCacheWrapper(new CacheWrapper($cache));
+            }
+        }
+    }
 }

src/Resources/BaseResource.php

@@ -2,6 +2,7 @@
 
 namespace DpdConnect\Sdk\Resources;
 
+use DpdConnect\Sdk\CacheWrapper;
 use DpdConnect\Sdk\Common\ResourceClient;
 use DpdConnect\Sdk\Common\ResponseError;
 use DpdConnect\Sdk\Exceptions;
@@ -13,7 +14,7 @@
  * @SuppressWarnings(PHPMD.NumberOfChildren)
  * @SuppressWarnings(PHPMD.TooManyFields)
  */
-class BaseResource
+class BaseResource implements CacheableInterface
 {
     /**
      * @var ResourceClient
@@ -26,9 +27,16 @@ class BaseResource
     protected $object;
 
     /**
-     * @param ResourceClient $resourceClient
+     * @var CacheWrapper
      */
-    public function __construct($resourceClient)
+    protected $cacheWrapper = null;
+
+    /**
+     * @param $resourceClient
+     */
+    public function __construct(
+        $resourceClient
+    )
     {
         $this->resourceClient = $resourceClient;
     }
@@ -73,4 +81,12 @@ public function processRequest($body)
         $ResponseError = new ResponseError($body);
         throw new RequestException($ResponseError->getErrorString());
     }
+
+    /**
+     * @param CacheWrapper|null $cacheWrapper
+     */
+    public function setCacheWrapper($cacheWrapper)
+    {
+        $this->cacheWrapper = $cacheWrapper;
+    }
 }

src/Resources/CacheInterface.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace DpdConnect\Sdk\Resources;
+
+interface CacheInterface
+{
+    /**
+     * @param string $key
+     * @param $data
+     * @param int $expire
+     * @return mixed
+     */
+    public function setCache($key, $data, $expire);
+
+    /**
+     * @param string $key
+     * @return mixed
+     */
+    public function getCache($key);
+}

src/Resources/CacheableInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace DpdConnect\Sdk\Resources;
+
+use DpdConnect\Sdk\CacheWrapper;
+
+interface CacheableInterface
+{
+    /**
+     * @param CacheWrapper $cacheWrapper
+     */
+    public function setCacheWrapper($cacheWrapper);
+}

src/Resources/Country.php

@@ -9,62 +9,23 @@
  */
 class Country extends BaseResource
 {
-    /**
-     * @param ResourceClient $resourceClient
-     */
-    public function __construct(
-        ResourceClient $resourceClient
-    ) {
-        parent::__construct($resourceClient);
-    }
-
     /**
      * @param array $query
      *
      * @return array
      */
     public function getList($query = [])
     {
-        $result = $this->getCachedList($query);
+        $result = $this->cacheWrapper->getCachedList($query);
 
         if ($result) {
             return $result;
         }
 
         $this->resourceClient->setResourceName('api/connect/v1/countries');
         $countries = $this->resourceClient->getResources($query);
-        $this->storeCachedList($countries, $query);
+        $this->cacheWrapper->storeCachedList($countries, $query);
 
         return $countries;
     }
-
-    /**
-     * @param $query
-     *
-     * @return false|mixed
-     */
-    private function getCachedList($query)
-    {
-        $filename = sys_get_temp_dir().'/dpd/'.sha1('dpd'.date('Ymd').serialize($query));
-
-        if (!file_exists($filename) || filesize($filename) == 0) {
-            return false;
-        }
-
-        return unserialize(file_get_contents($filename));
-    }
-
-    /**
-     * @param $countries
-     * @param $query
-     */
-    private function storeCachedList($countries, $query)
-    {
-        if (!file_exists(sys_get_temp_dir().'/dpd/')) {
-            mkdir(sys_get_temp_dir().'/dpd/');
-        }
-
-        $filename = sys_get_temp_dir().'/dpd/'.sha1('dpd'.date('Ymd').serialize($query));
-        file_put_contents($filename, serialize($countries));
-    }
 }

src/Resources/Job.php

@@ -10,14 +10,6 @@
  */
 class Job extends BaseResource
 {
-    /**
-     * @param ResourceClient $resourceClient
-     */
-    public function __construct($resourceClient)
-    {
-        parent::__construct($resourceClient);
-    }
-
     /**
      * @param $id
      *

src/Resources/Parcel.php

@@ -11,14 +11,6 @@
  */
 class Parcel extends BaseResource
 {
-    /**
-     * @param ResourceClient $resourceClient
-     */
-    public function __construct($resourceClient)
-    {
-        parent::__construct($resourceClient);
-    }
-
     /**
      * @param array $query
      *

src/Resources/Parcelshop.php

@@ -9,14 +9,6 @@
  */
 class Parcelshop extends BaseResource
 {
-    /**
-     * @param ResourceClient $resourceClient
-     */
-    public function __construct($resourceClient)
-    {
-        parent::__construct($resourceClient);
-    }
-
     /**
      * @param $id
      *

src/Resources/Product.php

@@ -13,68 +13,34 @@
  */
 class Product extends BaseResource
 {
-    /**
-     * @param ResourceClient $resourceClient
-     */
-    public function __construct(
-        ResourceClient $resourceClient
-    ) {
-        parent::__construct($resourceClient);
-    }
-
     /**
      * @param array $query
      * @return array
      * @throws DpdException
      */
     public function getList($query = [])
     {
-        $result = $this->getCachedList($query);
+        $result = $this->cacheWrapper->getCachedList($query);
         if ($result) {
             return $result;
         }
 
         $this->resourceClient->setResourceName('api/connect/v1/available-products');
         try {
             $products = $this->resourceClient->getResources($query);
-            $this->storeCachedList($products, $query);
+
+            $this->cacheWrapper->storeCachedList($products, $query);
             return $products;
         } catch (DpdException $e) {
-            $result = $this->getCachedList($query,31556926); //a year
+            $result = $this->cacheWrapper->getCachedList($query, true); //a year
+
+            // So we had a failure save cache now for an hour
+            $this->cacheWrapper->storeCachedList($result, $query);
+
             if ($result) {
                 return $result;
             }
             return [];
         }
     }
-
-    /**
-     * @param $query
-     *
-     * @return false|mixed
-     */
-    private function getCachedList($query, $maxAge = 3600)
-    {
-        $filename = sys_get_temp_dir() . '/dpd/dpd-products' ;
-
-        if (!file_exists($filename) || filesize($filename) == 0 || filemtime($filename) < time()-$maxAge) {
-            return false;
-        }
-
-        return unserialize(file_get_contents($filename));
-    }
-
-    /**
-     * @param $products
-     * @param $query
-     */
-    private function storeCachedList($products, $query)
-    {
-        if (!file_exists(sys_get_temp_dir() . '/dpd/')) {
-            mkdir(sys_get_temp_dir() . '/dpd/');
-        }
-
-        $filename = sys_get_temp_dir() .'/dpd/dpd-products';
-        file_put_contents($filename, serialize($products));
-    }
 }