Merge pull request #16 from UseMuffin/uuid-obfuscation

Add `UuidStrategy` for obfuscation

Author: ADmad

src/Model/Behavior/Strategy/UuidStrategy.php

@@ -0,0 +1,74 @@
+<?php
+namespace Muffin\Obfuscate\Model\Behavior\Strategy;
+
+use Cake\ORM\Table;
+
+/**
+ * Class UuidStrategy
+ *
+ */
+class UuidStrategy implements StrategyInterface
+{
+
+    /**
+     * UUID field to use.
+     *
+     * @var string
+     */
+    protected $_field;
+
+    /**
+     * Table using this strategy.
+     *
+     * @var Table
+     */
+    protected $_table;
+
+    /**
+     * Constructor.
+     *
+     * @param Table $table Instance of the table using the strategy.
+     * @param string $field Name of the UUID field on the table.
+     */
+    public function __construct($table, $field = 'uuid')
+    {
+        $this->_table = $table;
+        $this->_field = $field;
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param string $str String to obfuscate.
+     * @return string
+     */
+    public function obfuscate($str)
+    {
+        $record = $this->_table
+            ->find()
+            ->where([$this->_table->getPrimaryKey() => $str])
+            ->select([$this->_field])
+            ->firstOrFail();
+
+        return $record->{$this->_field};
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param string $str String to elucidate.
+     * @return string
+     */
+    public function elucidate($str)
+    {
+        $pk = $this->_table->getPrimaryKey();
+
+        $record = $this->_table
+            ->find()
+            ->where([$this->_field => $str])
+            ->select([$pk])
+            ->firstOrFail();
+
+        return $record->$pk;
+    }
+}

tests/Fixture/AuthorsFixture.php

@@ -14,6 +14,7 @@ class AuthorsFixture extends TestFixture
      */
     public $fields = [
         'id' => ['type' => 'integer'],
+        'uuid' => ['type' => 'string'],
         'name' => ['type' => 'string', 'null' => false],
         'created' => ['type' => 'datetime', 'null' => true],
         'modified' => ['type' => 'datetime', 'null' => true],
@@ -26,8 +27,8 @@ class AuthorsFixture extends TestFixture
      * @var array
      */
     public $records = [
-        ['name' => 'John'],
-        ['name' => 'Jane'],
+        ['name' => 'John', 'uuid' => 'f1f88079-ec15-4863-ad41-7e85cfa98f3d'],
+        ['name' => 'Jane', 'uuid' => 'a2234d7c-6de7-4b28-aa34-39d57f3d35e3'],
     ];
 
     public function init()

tests/TestCase/Model/Behavior/ObfuscateBehaviorTest.php

@@ -5,6 +5,7 @@
 use Cake\ORM\TableRegistry;
 use Cake\TestSuite\TestCase;
 use Muffin\Obfuscate\Model\Behavior\Strategy\TinyStrategy;
+use Muffin\Obfuscate\Model\Behavior\Strategy\UuidStrategy;
 
 class ObfuscateBehaviorTest extends TestCase
 {
@@ -33,15 +34,17 @@ public function setUp()
     {
         parent::setUp();
 
-        $strategy = new TinyStrategy('5SX0TEjkR1mLOw8Gvq2VyJxIFhgCAYidrclDWaM3so9bfzZpuUenKtP74QNH6B');
-
         $this->Authors = TableRegistry::get('Muffin/Obfuscate.Authors', ['table' => 'obfuscate_authors']);
-        $this->Authors->addBehavior('Muffin/Obfuscate.Obfuscate', compact('strategy'));
+        $this->Authors->addBehavior('Muffin/Obfuscate.Obfuscate', [
+            'strategy' => new UuidStrategy($this->Authors),
+        ]);
 
         $this->Comments = TableRegistry::get('Muffin/Obfuscate.Comments', ['table' => 'obfuscate_comments']);
 
         $this->Tags = TableRegistry::get('Muffin/Obfuscate.Tags', ['table' => 'obfuscate_tags']);
-        $this->Tags->addBehavior('Muffin/Obfuscate.Obfuscate', compact('strategy'));
+        $this->Tags->addBehavior('Muffin/Obfuscate.Obfuscate', [
+            'strategy' => new TinyStrategy('5SX0TEjkR1mLOw8Gvq2VyJxIFhgCAYidrclDWaM3so9bfzZpuUenKtP74QNH6B'),
+        ]);
 
         $this->Articles = TableRegistry::get('Muffin/Obfuscate.Articles', ['table' => 'obfuscate_articles']);
         $this->Articles->addBehavior('Muffin/Obfuscate.Obfuscate', ['strategy' => new TinyStrategy('5SX0TEjkR1mLOw8Gvq2VyJxIFhgCAYidrclDWaM3so9bfzZpuUenKtP74QNH6B')]);
@@ -91,7 +94,7 @@ public function testFindObfuscate()
             $this->Tags->getAlias(),
         ])->first();
 
-        $this->assertEquals('S', $result['author']['id']);
+        $this->assertEquals('f1f88079-ec15-4863-ad41-7e85cfa98f3d', $result['author']['id']);
         $this->assertEquals('S', $result['tags'][0]['id']);
         $this->assertEquals(1, $result['comments'][0]['id']);
         $this->assertEquals(2, $result['comments'][1]['id']);
@@ -125,6 +128,11 @@ public function testFindObfuscated()
             ->where(['id' => 'S'])
             ->toArray();
         $this->assertEquals('1', $results[0]['id']);
+
+        $results = $this->Authors->find('obfuscated')
+            ->where(['id' => 'f1f88079-ec15-4863-ad41-7e85cfa98f3d'])
+            ->toArray();
+        $this->assertEquals('1', $results[0]['id']);
     }
 
     /**