Basic built-in cache

composer.json

@@ -14,7 +14,8 @@
         "php": ">=5.3.3",
         "ext-curl": "*",
         "ext-json": "*",
-        "guzzle/guzzle": "~3.7"
+        "guzzle/guzzle": "~3.7",
+        "guzzle/plugin-cache": "v3.9.0"
     },
     "require-dev": {
         "phpunit/phpunit": "~3.7"

src/Prismic/Api.php

@@ -12,7 +12,8 @@
 namespace Prismic;
 
 use Guzzle\Http\Client;
-use Prismic\FieldForm;
+use Guzzle\Plugin\Cache\CachePlugin;
+use Guzzle\Plugin\Cache\DefaultCacheStorage;
 
 class Api
 {
@@ -142,15 +143,27 @@ public function getData()
     /**
      * This method is static to respect others API
      *
-     * @param string $action
-     * @param string $accessToken
+     * @param string                                  $action      the URL endpoint of the repository's API
+     * @param string                                  $accessToken an optional permanent access token (leave null is you're not sure what you're doing)
+     * @param string                                  $client      the client being used, or if null, will used a default client
+     * @param bool|Guzzle\Cache\CacheAdapterInterface $cache       the cache adapter being used, which must implement CacheAdapterInterface; set to true (default value) if you want the out-of-the box cache (a LRU cache of 100 entries); set to false if you want to disable the cache. If you want an LRU of 1000 entries, for instance, you can pass new LruCacheAdapter(1000).
      *
      * @return Api
      */
-    public static function get($action, $accessToken = null, $client = null)
+    public static function get($action, $accessToken = null, $client = null, $cache = true)
     {
         $url = $action . ($accessToken ? '?access_token=' . $accessToken : '');
         $client = isset($client) ? $client : self::defaultClient();
+
+        // Adding the cache in case it's provided
+        if (is_bool($cache)) {
+            if ($cache) {
+                $client->addSubscriber( new CachePlugin(array('storage' => new DefaultCacheStorage(new LruCacheAdapter(100)))) );
+            }
+        } else {
+            $client->addSubscriber( new CachePlugin(array('storage' => new DefaultCacheStorage($cache))) );
+        }
+
         $request = $client->get($url);
         $response = $request->send();
 
@@ -185,7 +198,7 @@ public static function defaultClient()
                 CURLOPT_CONNECTTIMEOUT => 10,
                 CURLOPT_RETURNTRANSFER => true,
                 CURLOPT_TIMEOUT        => 60,
-                CURLOPT_USERAGENT      => 'prismic-php-0.1',
+                CURLOPT_USERAGENT      => 'prismic-php-kit',
                 CURLOPT_HTTPHEADER     => array('Accept: application/json')
             )
         ));

src/Prismic/Document.php

@@ -104,7 +104,7 @@ public function get($field)
      * @param string $field
      *
      * @return bool
-     * */
+     *              */
      public function has($field)
      {
          return array_key_exists($field, $this->fragments);
@@ -180,6 +180,7 @@ public function getBoolean($field)
         $fragment = $this->get($field);
         if (isset($fragment) && $fragment instanceof Text) {
             $value = strtolower($fragment->getValue());
+
             return in_array(strtolower($fragment->getValue()), array(
                 'yes',
                 'true',

src/Prismic/Fragment/Group.php

@@ -32,6 +32,7 @@ public function asHtml($linkResolver = null)
                            "</section>";
             }
         }
+
         return $string;
     }
 
@@ -43,6 +44,7 @@ public function asText()
                 $string .= $subfragment->asText();
             }
         }
+
         return $string;
     }
 
@@ -60,6 +62,7 @@ public static function parseSubfragmentList($json)
                 $subfragments[$subfragment_name] = $subfragment;
             }
         }
+
         return $subfragments;
     }
 

src/Prismic/Fragment/ImageView.php

@@ -44,6 +44,7 @@ public function asHtml($linkResolver = null, $attributes = array())
             $img->setAttribute($key, $value);
         }
         $doc->appendChild($img);
+
         return trim($doc->saveHTML()); // trim removes trailing newline
     }
 

src/Prismic/Fragment/StructuredText.php

@@ -196,9 +196,9 @@ public static function asHtmlText($text, $spans, $linkResolver = null)
                 $attributes = array();
                 if ($span instanceof StrongSpan) {
                     $nodeName = 'strong';
-                } else if ($span instanceof EmSpan) {
+                } elseif ($span instanceof EmSpan) {
                     $nodeName = 'em';
-                } else if ($span instanceof HyperlinkSpan) {
+                } elseif ($span instanceof HyperlinkSpan) {
                     $nodeName = 'a';
                     if ($span->getLink() instanceof DocumentLink) {
                         $attributes['href'] = $linkResolver ? $linkResolver($span->getLink()) : '';

src/Prismic/LruCacheAdapter.php

@@ -0,0 +1,77 @@
+<?php
+
+/*
+ * This file is part of the Prismic PHP SDK
+ *
+ * Copyright 2013 Zengularity (http://www.zengularity.com).
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Prismic;
+
+use Guzzle\Cache\CacheAdapterInterface;
+
+class LruCacheAdapter implements CacheAdapterInterface
+{
+
+    protected $maxSize;
+    protected $cache;
+
+    public function __construct($maxSize)
+    {
+        $this->maxSize = $maxSize;
+        $this->cache = array();
+    }
+
+    public function contains($id, array $options = null)
+    {
+        // check if contained
+        return array_key_exists($id, $this->cache);
+    }
+
+    public function delete($id, array $options = null)
+    {
+        $existed = $this->contains($id);
+        unset($this->cache[$id]);
+
+        return $existed;
+    }
+
+    public function fetch($id, array $options = null)
+    {
+        if ($this->contains($id)) {
+            // fetch data
+            $data = $this->cache[$id];
+            // delete entry to put it back at the end of the array (and let it live longer)
+            unset($this->cache[$id]);
+            $this->cache[$id] = $data;
+            // return the data
+            return $data;
+        } else {
+            return null;
+        }
+    }
+
+    public function save($id, $data, $lifeTime = false, array $options = null)
+    {
+        // save value at the end of the array
+        $this->cache[$id] = $data;
+        // checks if size too big --> shift the array
+        if ($this->size() > $this->maxSize) {
+            array_shift($this->cache);
+        }
+    }
+
+    public function size()
+    {
+        return count($this->cache);
+    }
+
+    public function toArray()
+    {
+        return $this->cache;
+    }
+
+}

tests/Prismic/CacheTest.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Prismic\Test;
+
+use Prismic\LruCacheAdapter;
+
+class CacheTest extends \PHPUnit_Framework_TestCase
+{
+    protected $cache;
+
+    protected function setUp()
+    {
+        $this->cache = new LruCacheAdapter(5);
+    }
+
+    public function testCheckInitializationIsRight()
+    {
+        $this->assertEquals(0, $this->cache->size());
+    }
+
+    public function testCheckAddingCacheEntrie()
+    {
+        $this->cache->save('key1', 'value1');
+        $this->cache->save('key2', 'value2');
+        $this->cache->save('key3', 'value3');
+        $this->cache->save('key4', 'value4');
+        $this->cache->save('key5', 'value5');
+        $this->cache->save('key6', 'value6');
+        $this->assertEquals(5, $this->cache->size());
+
+        // checking that key1 is the one that's gone
+        $this->assertTrue($this->cache->contains('key2') && $this->cache->contains('key3') && $this->cache->contains('key4') && $this->cache->contains('key5') && $this->cache->contains('key6') && !$this->cache->contains('key1'));
+    }
+
+    public function testFetchingAndReordering()
+    {
+        $this->cache->save('key1', 'value1');
+        $this->cache->save('key2', 'value2');
+        $this->cache->save('key3', 'value3');
+        $this->cache->save('key4', 'value4');
+        $this->assertEquals('value1', $this->cache->fetch('key1')); // fetching key1 now puts it back at the end of the array, so it doesn't get deleted too soon
+        $this->cache->save('key5', 'value5');
+        $this->cache->save('key6', 'value6');
+        $this->assertEquals(5, $this->cache->size());
+
+        // checking that key2 is the one that's gone
+        $this->assertTrue($this->cache->contains('key1') && $this->cache->contains('key3') && $this->cache->contains('key4') && $this->cache->contains('key5') && $this->cache->contains('key6') && !$this->cache->contains('key2'));
+    }
+
+}