Release 1.0.0

Author: Nikola

.editorconfig

@@ -0,0 +1,21 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.php]
+indent_style = space
+indent_size = 4
+
+[*.{json,yml,yaml}]
+indent_style = space
+indent_size = 4
+
+[*.md]
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab

.github/workflows/ci.yml

@@ -0,0 +1,70 @@
+name: CI
+
+on:
+  push:
+    branches: [master, develop]
+  pull_request:
+    branches: [master, develop]
+
+jobs:
+  tests:
+    name: PHP ${{ matrix.php-version }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        php-version: ["8.2", "8.3", "8.4"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          extensions: mbstring, sodium
+          coverage: none
+
+      - name: Install dependencies
+        run: composer install --no-interaction --prefer-dist
+
+      - name: Run tests
+        run: composer test
+
+  cs:
+    name: Code Style
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "8.3"
+          coverage: none
+
+      - name: Install dependencies
+        run: composer install --no-interaction --prefer-dist
+
+      - name: Run phpcs
+        run: composer cs
+
+  stan:
+    name: Static Analysis
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "8.3"
+          coverage: none
+
+      - name: Install dependencies
+        run: composer install --no-interaction --prefer-dist
+
+      - name: Run phpstan
+        run: composer stan 2>/dev/null || vendor/bin/phpstan analyse

README.md

@@ -106,7 +106,7 @@ public function initialize(): void
     parent::initialize();
     $this->loadComponent('Flash');
     $this->loadComponent('Authentication.Authentication');
-    $this->loadComponent('Verification.Verification');
+    $this->loadComponent('CakeVerification.Verification');
 }
 ```
 

composer.json

@@ -3,19 +3,20 @@
     "description": "Verification and step-up authentication for CakePHP 5: email verification links, Email OTP, SMS OTP, and TOTP.",
     "type": "cakephp-plugin",
     "license": "MIT",
+    "keywords": ["cakephp", "plugin", "verification", "authentication", "otp", "totp", "2fa", "mfa", "sms", "email"],
     "require": {
         "php": "^8.2",
         "cakephp/cakephp": "^5.3",
         "cakephp/authentication": "^4.0"
     },
     "autoload": {
         "psr-4": {
-            "Verification\\": "src/"
+            "CakeVerification\\": "src/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "Verification\\Test\\": "tests/"
+            "CakeVerification\\Test\\": "tests/"
         }
     },
     "suggest": {
@@ -29,7 +30,8 @@
     "scripts": {
         "test": "phpunit",
         "cs": "phpcs -p",
-        "cbf": "phpcbf"
+        "cbf": "phpcbf",
+        "stan": "phpstan analyse --memory-limit=512M"
     },
     "support": {
         "issues": "https://github.com/salines/cakephp-verification/issues",
@@ -42,6 +44,9 @@
             "url": "https://www.paypal.me/paradzikn"
         }
     ],
+    "extra": {
+        "installer-name": "CakeVerification"
+    },
     "config": {
         "allow-plugins": {
             "dealerdirect/phpcodesniffer-composer-installer": true

config/bootstrap.php

@@ -10,7 +10,7 @@
 try {
     Configure::config('default', new PhpConfig());
     // Load plugin defaults (false = overwrite), then restore app overrides on top.
-    Configure::load('Verification.verification', 'default', false);
+    Configure::load('CakeVerification.verification', 'default', false);
 } catch (Exception $e) {
     exit($e->getMessage() . "\n");
 }

config/verification.php

@@ -1,11 +1,11 @@
 <?php
 declare(strict_types=1);
 
-use Verification\Transport\Sms\Driver\DummyTransport;
-use Verification\Verificator\Driver\EmailOtpVerificator;
-use Verification\Verificator\Driver\EmailVerifyVerificator;
-use Verification\Verificator\Driver\SmsOtpVerificator;
-use Verification\Verificator\Driver\TotpVerificator;
+use CakeVerification\Transport\Sms\Driver\DummyTransport;
+use CakeVerification\Verificator\Driver\EmailOtpVerificator;
+use CakeVerification\Verificator\Driver\EmailVerifyVerificator;
+use CakeVerification\Verificator\Driver\SmsOtpVerificator;
+use CakeVerification\Verificator\Driver\TotpVerificator;
 
 /**
  * salines/verification — default configuration.

docs/api/sms_transport.md

@@ -9,10 +9,10 @@ see [sms_verification.md](../sms_verification.md).
 
 ## TransportInterface
 
-Every SMS transport must implement `Verification\Transport\Sms\TransportInterface`:
+Every SMS transport must implement `CakeVerification\Transport\Sms\TransportInterface`:
 
 ```php
-namespace Verification\Transport\Sms;
+namespace CakeVerification\Transport\Sms;
 
 interface TransportInterface
 {
@@ -46,9 +46,9 @@ interface TransportInterface
 ```php
 namespace App\Sms;
 
-use Verification\Transport\Sms\Message;
-use Verification\Transport\Sms\Result;
-use Verification\Transport\Sms\TransportInterface;
+use CakeVerification\Transport\Sms\Message;
+use CakeVerification\Transport\Sms\Result;
+use CakeVerification\Transport\Sms\TransportInterface;
 
 class TwilioTransport implements TransportInterface
 {

docs/api/verificator_interface.md

@@ -10,7 +10,7 @@ If you need a custom step (e.g. backup codes, hardware key), implement this inte
 ## Interface
 
 ```php
-namespace Verification\Verificator;
+namespace CakeVerification\Verificator;
 
 use Authentication\IdentityInterface;
 use Psr\Http\Message\ServerRequestInterface;
@@ -54,7 +54,7 @@ namespace App\Verification;
 
 use Authentication\IdentityInterface;
 use Psr\Http\Message\ServerRequestInterface;
-use Verification\Verificator\VerificationVerificatorInterface;
+use CakeVerification\Verificator\VerificationVerificatorInterface;
 
 class BackupCodeVerificator implements VerificationVerificatorInterface
 {

docs/email_verification.md

@@ -267,7 +267,7 @@ bundled templates:
 
 ```php
 $this->viewBuilder()
-     ->setPlugin('Verification')
+     ->setPlugin('CakeVerification')
      ->setTemplate('email_otp');
 ```
 

docs/installation.md

@@ -24,7 +24,7 @@ This adds an entry to `config/plugins.php`. Alternatively, add it manually in
 `src/Application.php`:
 
 ```php
-$this->addPlugin('Verification');
+$this->addPlugin('CakeVerification');
 ```
 
 ## 3) Publish config
@@ -45,7 +45,7 @@ public function initialize(): void
     parent::initialize();
     $this->loadComponent('Flash');
     $this->loadComponent('Authentication.Authentication');
-    $this->loadComponent('Verification.Verification');
+    $this->loadComponent('CakeVerification.Verification');
 }
 ```