rollback improvements

Author: mathleite

.env.example

@@ -0,0 +1,13 @@
+# NOTIFICATION
+SLACK_API_WEBHOOK=Your_webhook_here
+
+# DATE
+DEFAULT_DATE_TIMEZONE=America/Sao_Paulo
+
+# DATABASE
+DATABASE_USER=xpto
+DATABASE_PASSWORD=xpto_password
+DATABASE_NAME=xpto_database_name
+DATABASE_DRIVER=xpto_driver
+DATABASE_HOST=xpto_host
+DATABASE_SCHEMA=xpto_schema

.github/workflows/build.yml

@@ -1,23 +1,23 @@
-name: CI
-
-on:
-  push:
-    branches:
-      - master
-
-jobs:
-  build:
-    runs-on: [ ubuntu-latest ]
-    steps:
-      - uses: actions/checkout@v1
-
-      - name: Cache PHP dependencies
-        uses: actions/cache@v1
-        with:
-          path: vendor
-          key: ${{ runner.OS }}-build-${{ hashFiles('**/composer.lock') }}
-
-      - uses: php-actions/composer@master
-
-      - name: Run Tests
-        run: composer tests-exclude-notification
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: [ ubuntu-latest ]
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Cache PHP dependencies
+        uses: actions/cache@v1
+        with:
+          path: vendor
+          key: ${{ runner.OS }}-build-${{ hashFiles('**/composer.lock') }}
+
+      - uses: php-actions/composer@master
+
+      - name: Run Tests
+        run: composer test

.gitignore

@@ -1,2 +1,6 @@
-.idea
-vendor
+# FOLDERS
+.idea
+vendor
+
+# FILES
+.phpunit.result.cache

Dockerfile

@@ -1,4 +1,4 @@
-FROM php:8-fpm-buster
-
-RUN apt-get update && apt-get install -y curl git
-RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
+FROM php:8-fpm-buster
+
+RUN apt-get update && apt-get install -y curl git
+RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer

README.md

@@ -1,38 +1,38 @@
-<h1 align="center">Simple PHP Router</h1>
-
-<p align="center">
-    <a href="https://github.com/mathleite/simple-php-router">
-        <img src="https://github.com/mathleite/simple-php-router/workflows/CI/badge.svg" alt="Workflow badge">
-    </a>
-</p>
-
-| SETUP  |
-|:------:|
-| Nginx  |
-| PHP8 |
-| Docker |
-
-
-#### Start app
-- Build Docker containers
-    ```docker
-    docker-compose up --build -d
-    ```
-
-- Install Composer dependencies
-    ```docker
-    docker exec -it php composer install
-    ```
-
-### Create your own routes
-
-`app/Route/index.php`
-
-```php
-$route->registry('/greet', \App\Greet\GreetController::class, 'index');
-```
-
-Where:
-- `/user` is the **route** that you want to *register*;
-- `\App\Greet\GreetController::class` is the *Controller* **namespace**;
-- `index` is a controller *function*
+<h1 align="center">Simple PHP Router</h1>
+
+<p align="center">
+    <a href="https://github.com/mathleite/simple-php-router">
+        <img src="https://github.com/mathleite/simple-php-router/workflows/CI/badge.svg" alt="Workflow badge">
+    </a>
+</p>
+
+| SETUP  |
+|:------:|
+| Nginx  |
+| PHP8 |
+| Docker |
+
+
+#### Start app
+- Build Docker containers
+    ```docker
+    docker-compose up --build -d
+    ```
+
+- Install Composer dependencies
+    ```docker
+    docker exec -it php composer install
+    ```
+
+### Create your own routes
+
+`app/Route/index.php`
+
+```php
+$route->registry('/greet', \App\Greet\GreetController::class, 'index');
+```
+
+Where:
+- `/user` is the **route** that you want to *register*;
+- `\App\Greet\GreetController::class` is the *Controller* **namespace**;
+- `index` is a controller *function*

app/Base/ControllerInterface.php

@@ -1,10 +1,10 @@
-<?php
-
-
-namespace App\Base;
-
-
-interface ControllerInterface
-{
-    public static function index(): void;
-}
+<?php
+
+
+namespace App\Base;
+
+
+interface ControllerInterface
+{
+    public static function index(): void;
+}

app/Date/index.php

@@ -0,0 +1,3 @@
+<?php
+
+date_default_timezone_set(getenv('DEFAULT_DATE_TIMEZONE'));

app/DotEnvLoader/index.php

@@ -0,0 +1,4 @@
+<?php
+
+$dotenv = \Dotenv\Dotenv::createImmutable(__DIR__ . '/../../');
+$dotenv->load();

app/Greet/GreetController.php

@@ -1,14 +1,14 @@
-<?php
-
-namespace App\Greet;
-
-use App\Base\ControllerInterface;
-
-class GreetController implements ControllerInterface
-{
-    public static function index(): void
-    {
-        echo 'Hi! I am a index function :)';
-    }
-
-}
+<?php
+
+namespace App\Greet;
+
+use App\Base\ControllerInterface;
+
+class GreetController implements ControllerInterface
+{
+    public static function index(): void
+    {
+        echo 'Hi! I am a index function :)';
+    }
+
+}

app/Greet/UserModel.php

@@ -0,0 +1,15 @@
+<?php
+
+
+namespace App\Notification;
+
+
+use App\Notification\Client\HTTPClientAdapterInterface;
+use App\Notification\Client\ResponseAdapterInterface;
+
+interface AppNotificationInterface
+{
+    public function __construct(HTTPClientAdapterInterface $client, string $message, string $messageType);
+
+    public function notify(): ResponseAdapterInterface;
+}

app/Notification/AppNotificationInterface.php

@@ -0,0 +1,32 @@
+<?php
+
+
+namespace App\Notification\Client\Guzzle;
+
+
+use App\Notification\Client\HTTPClientAdapterInterface;
+use App\Notification\Client\ResponseAdapterInterface;
+use GuzzleHttp\Client;
+use Psr\Http\Message\ResponseInterface;
+
+class GuzzleHTTPClient implements HTTPClientAdapterInterface
+{
+    private Client $client;
+
+    public function __construct()
+    {
+        $this->client = new Client();
+    }
+
+    public function post(string $url, array $params): ResponseAdapterInterface
+    {
+        $clientResponse = $this->client->post(
+            $url,
+            [
+                'json' => $params
+            ]
+        );
+
+        return new GuzzleResponse($clientResponse);
+    }
+}

app/Notification/Client/Guzzle/GuzzleHTTPClient.php

@@ -0,0 +1,31 @@
+<?php
+
+
+namespace App\Notification\Client\Guzzle;
+
+
+use App\Notification\Client\ResponseAdapterInterface;
+use Psr\Http\Message\ResponseInterface;
+
+class GuzzleResponse implements ResponseAdapterInterface
+{
+    private ResponseInterface $clientResponse;
+
+    public function __construct(ResponseInterface $clientResponse)
+    {
+        $this->clientResponse = $clientResponse;
+    }
+
+    public function getResponse(): array
+    {
+        return self::sanitizeResponse($this->clientResponse);
+    }
+
+    private static function sanitizeResponse(ResponseInterface $guzzleResponse): array
+    {
+        return [
+            'status_code' => $guzzleResponse->getStatusCode(),
+            'message'     => $guzzleResponse->getReasonPhrase()
+        ];
+    }
+}

app/Notification/Client/Guzzle/GuzzleResponse.php

@@ -0,0 +1,10 @@
+<?php
+
+
+namespace App\Notification\Client;
+
+
+interface HTTPClientAdapterInterface
+{
+    public function post(string $url, array $params): ResponseAdapterInterface;
+}

app/Notification/Client/HTTPClientAdapterInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+
+namespace App\Notification\Client;
+
+
+interface ResponseAdapterInterface
+{
+    public function getResponse(): array;
+}

app/Notification/Client/ResponseAdapterInterface.php

@@ -0,0 +1,20 @@
+<?php
+
+
+namespace App\Notification;
+
+/**
+ * Class MessageTypeEnum
+ *
+ * @package App\Notification
+ * @method static string ERROR()
+ */
+final class NotificationTypeEnum
+{
+    private const ERROR = 'error';
+
+    public static function __callStatic($name, $arguments): string
+    {
+        return constant('self::' . strtoupper($name));
+    }
+}

app/Notification/NotificationTypeEnum.php

@@ -0,0 +1,29 @@
+<?php
+
+
+namespace App\Notification\Slack;
+
+
+use App\Notification\AppNotificationInterface;
+use App\Notification\Client\HTTPClientAdapterInterface;
+use App\Notification\Client\ResponseAdapterInterface;
+
+final class SlackNotification implements AppNotificationInterface
+{
+    private SlackStylizedMessageCreator $message;
+    private HTTPClientAdapterInterface $client;
+
+    public function __construct(HTTPClientAdapterInterface $client, string $message, string $messageType)
+    {
+        $this->message = new SlackStylizedMessageCreator($message, $messageType);
+        $this->client  = $client;
+    }
+
+    public function notify(): ResponseAdapterInterface
+    {
+        return $this->client->post(
+            getenv('SLACK_API_WEBHOOK'),
+            $this->message->getStructuredMessage()
+        );
+    }
+}