Merge pull request #50 from maurobonfietti/v0.27.0

Release Version 0.27.0

.env.example

@@ -5,6 +5,5 @@ DB_PASSWORD=''
 
 DISPLAY_ERROR_DETAILS=true
 APP_DOMAIN='https://www.yourdomain.com'
-USE_REDIS_CACHE=false
 REDIS_URL=''
 SECRET_KEY='YourSuperSecret-KeY'

.travis.yml

@@ -14,7 +14,6 @@ env:
     - DB_DATABASE=rest_api_slim_php
     - DB_USERNAME=root
     - DB_PASSWORD=
-    - USE_REDIS_CACHE=true
     - REDIS_URL=localhost
     - SECRET_KEY=YourSuperSecret-KeY
 

README.md

@@ -123,7 +123,6 @@ For example:
 ```
 DISPLAY_ERROR_DETAILS=true
 APP_DOMAIN='https://www.yourdomain.com'
-USE_REDIS_CACHE=false
 REDIS_URL=''
 SECRET_KEY='YourSuperSecret-KeY'
 ```

README_SPANISH.md

@@ -124,7 +124,6 @@ Por ejemplo:
 ```
 DISPLAY_ERROR_DETAILS=true
 APP_DOMAIN='https://www.yourdomain.com'
-USE_REDIS_CACHE=false
 REDIS_URL=''
 SECRET_KEY='YourSuperSecret-KeY'
 ```

src/App/Settings.php

@@ -9,6 +9,5 @@
             'username' => getenv('DB_USERNAME'),
             'password' => getenv('DB_PASSWORD'),
         ],
-        'useRedisCache' => filter_var(getenv('USE_REDIS_CACHE'), FILTER_VALIDATE_BOOLEAN),
     ],
 ];

src/Controller/BaseController.php

@@ -59,14 +59,4 @@ protected function getInput()
     {
         return $this->request->getParsedBody();
     }
-
-    protected function getRedisClient(): \Predis\Client
-    {
-        return $this->container->get('redis');
-    }
-
-    protected function useRedis(): bool
-    {
-        return $this->container->get('settings')['useRedisCache'];
-    }
 }

src/Controller/DefaultController.php

@@ -8,7 +8,7 @@
 
 class DefaultController extends BaseController
 {
-    const API_VERSION = '0.26.0';
+    const API_VERSION = '0.27.0';
 
     public function __construct(Container $container)
     {
@@ -23,6 +23,7 @@ public function getHelp(Request $request, Response $response, array $args): Resp
             'tasks' => $url . '/api/v1/tasks',
             'users' => $url . '/api/v1/users',
             'notes' => $url . '/api/v1/notes',
+            'docs' => $url . '/docs/index.html',
             'status' => $url . '/status',
             'this help' => $url . '',
         ];

src/Controller/Note/BaseNote.php

@@ -8,11 +8,6 @@
 
 abstract class BaseNote extends BaseController
 {
-    /**
-     * @var NoteService
-     */
-    protected $noteService;
-
     public function __construct(Container $container)
     {
         $this->container = $container;

src/Controller/Task/BaseTask.php

@@ -8,18 +8,13 @@
 
 abstract class BaseTask extends BaseController
 {
-    /**
-     * @var TaskService
-     */
-    protected $taskService;
-
     public function __construct(Container $container)
     {
-        $this->taskService = $container->get('task_service');
+        $this->container = $container;
     }
 
     protected function getTaskService(): TaskService
     {
-        return $this->taskService;
+        return $this->container->get('task_service');
     }
 }

src/Controller/User/BaseUser.php

@@ -9,11 +9,6 @@
 
 abstract class BaseUser extends BaseController
 {
-    /**
-     * @var UserService
-     */
-    protected $userService;
-
     public function __construct(Container $container)
     {
         $this->container = $container;
@@ -24,9 +19,6 @@ protected function getUserService(): UserService
         return $this->container->get('user_service');
     }
 
-    /**
-     * @throws UserException
-     */
     protected function checkUserPermissions()
     {
         $input = $this->getInput();

src/Middleware/AuthMiddleware.php

@@ -10,13 +10,6 @@
 
 class AuthMiddleware
 {
-    /**
-     * @param Request $request
-     * @param Response $response
-     * @param Callable $next
-     * @return ResponseInterface
-     * @throws AuthException
-     */
     public function __invoke(Request $request, Response $response, $next): ResponseInterface
     {
         $jwtHeader = $request->getHeaderLine('Authorization');

src/Repository/BaseRepository.php

@@ -4,9 +4,6 @@
 
 abstract class BaseRepository
 {
-    /**
-     * @var \PDO $database
-     */
     protected $database;
 
     protected function getDb(): \PDO

src/Service/BaseService.php

@@ -9,11 +9,6 @@
 
 abstract class BaseService
 {
-    public function useRedis(): bool
-    {
-        return filter_var(getenv('USE_REDIS_CACHE'), FILTER_VALIDATE_BOOLEAN);
-    }
-
     protected static function validateUserName(string $name): string
     {
         if (!v::alnum()->length(2, 100)->validate($name)) {

src/Service/NoteService.php

@@ -7,9 +7,6 @@
 
 class NoteService extends BaseService
 {
-    /**
-     * @var NoteRepository
-     */
     protected $noteRepository;
 
     protected $redisService;
@@ -32,8 +29,8 @@ public function getNotes(): array
 
     public function getNote(int $noteId)
     {
-        $key = "note:$noteId";
-        if ($this->useRedis() === true && $this->redisService->exists($key)) {
+        $key = $this->redisService->generateKey("note:$noteId");
+        if ($this->redisService->exists($key)) {
             $note = $this->redisService->get($key);
         } else {
             $note = $this->checkAndGetNote($noteId);
@@ -61,10 +58,8 @@ public function createNote($input)
             $note->description = $data->description;
         }
         $notes = $this->noteRepository->createNote($note);
-        if ($this->useRedis() === true) {
-            $key = "note:" . $notes->id;
-            $this->redisService->setex($key, $notes);
-        }
+        $key = $this->redisService->generateKey("note:" . $notes->id);
+        $this->redisService->setex($key, $notes);
 
         return $notes;
     }
@@ -83,10 +78,8 @@ public function updateNote($input, int $noteId)
             $note->description = $data->description;
         }
         $notes = $this->noteRepository->updateNote($note);
-        if ($this->useRedis() === true) {
-            $key = "note:" . $notes->id;
-            $this->redisService->setex($key, $notes);
-        }
+        $key = $this->redisService->generateKey("note:" . $notes->id);
+        $this->redisService->setex($key, $notes);
 
         return $notes;
     }
@@ -95,9 +88,7 @@ public function deleteNote(int $noteId)
     {
         $this->checkAndGetNote($noteId);
         $this->noteRepository->deleteNote($noteId);
-        if ($this->useRedis() === true) {
-            $key = "note:" . $noteId;
-            $this->redisService->del($key);
-        }
+        $key = $this->redisService->generateKey("note:" . $noteId);
+        $this->redisService->del($key);
     }
 }

src/Service/RedisService.php

@@ -13,40 +13,33 @@ public function __construct($redis)
         $this->redis = $redis;
     }
 
-    private function generateKey($value)
+    public function generateKey($value)
     {
         return self::PROJECT_NAME . ':' . $value;
     }
 
     public function exists($key)
     {
-        $key = $this->generateKey($key);
-
         return $this->redis->exists($key);
     }
 
     public function get($key)
     {
-        $key = $this->generateKey($key);
-
         return json_decode($this->redis->get($key), true);
     }
 
     public function set($key, $value)
     {
-        $key = $this->generateKey($key);
         $this->redis->set($key, json_encode($value));
     }
 
-    public function del($key)
+    public function setex($key, $value, $ttl = 3600)
     {
-        $key = $this->generateKey($key);
-        $this->redis->del($key);
+        $this->redis->setex($key, $ttl, json_encode($value));
     }
 
-    public function setex($key, $value, $ttl = 3600)
+    public function del($key)
     {
-        $key = $this->generateKey($key);
-        $this->redis->setex($key, $ttl, json_encode($value));
+        $this->redis->del($key);
     }
 }

src/Service/TaskService.php

@@ -7,9 +7,6 @@
 
 class TaskService extends BaseService
 {
-    /**
-     * @var TaskRepository
-     */
     protected $taskRepository;
 
     protected $redisService;
@@ -42,8 +39,8 @@ public function getTasks(int $userId): array
 
     public function getTask(int $taskId, int $userId)
     {
-        $key = "task:$taskId:user:$userId";
-        if ($this->useRedis() === true && $this->redisService->exists($key)) {
+        $key = $this->redisService->generateKey("task:$taskId:user:$userId");
+        if ($this->redisService->exists($key)) {
             $task = $this->redisService->get($key);
         } else {
             $task = $this->checkAndGetTask($taskId, $userId);
@@ -80,10 +77,8 @@ public function createTask(array $input)
         }
         $task->userId = $data->decoded->sub;
         $tasks = $this->getTaskRepository()->createTask($task);
-        if ($this->useRedis() === true) {
-            $key = "task:" . $tasks->id . ":user:" . $task->userId;
-            $this->redisService->setex($key, $tasks);
-        }
+        $key = $this->redisService->generateKey("task:" . $tasks->id . ":user:" . $task->userId);
+        $this->redisService->setex($key, $tasks);
 
         return $tasks;
     }
@@ -106,10 +101,8 @@ public function updateTask(array $input, int $taskId)
         }
         $task->userId = $data->decoded->sub;
         $tasks = $this->getTaskRepository()->updateTask($task);
-        if ($this->useRedis() === true) {
-            $key = "task:" . $tasks->id . ":user:" . $task->userId;
-            $this->redisService->setex($key, $tasks);
-        }
+        $key = $this->redisService->generateKey("task:" . $tasks->id . ":user:" . $task->userId);
+        $this->redisService->setex($key, $tasks);
 
         return $tasks;
     }
@@ -118,10 +111,8 @@ public function deleteTask(int $taskId, int $userId): string
     {
         $this->checkAndGetTask($taskId, $userId);
         $data = $this->getTaskRepository()->deleteTask($taskId, $userId);
-        if ($this->useRedis() === true) {
-            $key = "task:" . $taskId . ":user:" . $userId;
-            $this->redisService->del($key);
-        }
+        $key = $this->redisService->generateKey("task:" . $taskId . ":user:" . $userId);
+        $this->redisService->del($key);
 
         return $data;
     }

src/Service/UserService.php

@@ -8,9 +8,6 @@
 
 class UserService extends BaseService
 {
-    /**
-     * @var UserRepository
-     */
     protected $userRepository;
 
     protected $redisService;
@@ -33,8 +30,8 @@ public function getUsers(): array
 
     public function getUser(int $userId)
     {
-        $key = "user:$userId";
-        if ($this->useRedis() === true && $this->redisService->exists($key)) {
+        $key = $this->redisService->generateKey("user:$userId");
+        if ($this->redisService->exists($key)) {
             $data = $this->redisService->get($key);
             $user = json_decode(json_encode($data), false);
         } else {
@@ -68,10 +65,8 @@ public function createUser($input)
         $user->password = hash('sha512', $data->password);
         $this->userRepository->checkUserByEmail($user->email);
         $users = $this->userRepository->createUser($user);
-        if ($this->useRedis() === true) {
-            $key = "user:" . $users->id;
-            $this->redisService->setex($key, $users);
-        }
+        $key = $this->redisService->generateKey("user:" . $users->id);
+        $this->redisService->setex($key, $users);
 
         return $users;
     }
@@ -90,10 +85,8 @@ public function updateUser(array $input, int $userId)
             $user->email = self::validateEmail($data->email);
         }
         $users = $this->userRepository->updateUser($user);
-        if ($this->useRedis() === true) {
-            $key = "user:" . $users->id;
-            $this->redisService->setex($key, $users);
-        }
+        $key = $this->redisService->generateKey("user:" . $users->id);
+        $this->redisService->setex($key, $users);
 
         return $users;
     }
@@ -103,10 +96,8 @@ public function deleteUser(int $userId): string
         $this->checkAndGetUser($userId);
         $this->userRepository->deleteUserTasks($userId);
         $data = $this->userRepository->deleteUser($userId);
-        if ($this->useRedis() === true) {
-            $key = "user:" . $userId;
-            $this->redisService->del($key);
-        }
+        $key = $this->redisService->generateKey("user:" . $userId);
+        $this->redisService->del($key);
 
         return $data;
     }