Merge pull request #5 from lion-packages/support

Library documentation and updated dependencies

README.md

@@ -16,6 +16,7 @@
 </p>
 
 ## Install
+
 ```bash
 composer require lion/authentication
 ```

api.php

@@ -4,7 +4,7 @@
 
 header('Content-Type: application/json');
 
-use LionAuthentication\Auth2FA;
+use Lion\Authentication\Auth2FA;
 
 $content = json_decode(file_get_contents("php://input"), true);
 $request = $content === null ? ((object) [...$_POST, ...$_GET]) : ((object) $content);

index.php

@@ -2,7 +2,7 @@
 
 require_once('./vendor/autoload.php');
 
-use LionAuthentication\Auth2FA;
+use Lion\Authentication\Auth2FA;
 
 header('Content-Type: application/json');
 

src/LionAuthentication/Auth2FA.php

@@ -6,24 +6,49 @@
 
 use PragmaRX\Google2FAQRCode\Google2FA;
 
+/**
+ * Provides functionality for two-factor authentication (2FA) using Google
+ * Authenticator
+ *
+ * @package Lion\Authentication
+ */
 class Auth2FA
 {
+    /**
+     * [Google2FA class object]
+     *
+     * @var Google2FA $google2FA
+     */
 	private Google2FA $google2FA;
 
+    /**
+     * Class constructor
+     */
 	public function __construct()
     {
         $this->google2FA = new Google2FA();
     }
 
+    /**
+     * Generates a QR code for two-factor authentication (2FA)
+     *
+     * @param  string $companyName [The name of the company]
+     * @param  string $companyEmail [The company email]
+     * @param  int $size [The desired size for the QR code]
+     * @param  string $encoding [Text encoding]
+     * @param  int $length [The length of the secret key]
+     * @param  string $prefix [The optional prefix for the secret key]
+     *
+     * @return object
+     */
 	public function qr(
         string $companyName,
         string $companyEmail,
         int $size = 200,
         string $encoding = 'utf-8',
         int $length = 16,
-        string $prefix = '',
-    ): object
-    {
+        string $prefix = ''
+    ): object {
 		$secretKey = $this->google2FA->generateSecretKey($length, $prefix);
 
 		$img = base64_encode(
@@ -41,6 +66,16 @@ public function qr(
         ];
 	}
 
+    /**
+     * Verifies the authenticity of a given secret code, relative to a given
+     * secret key
+     *
+     * @param  string $secretKey [The secret key used to generate the QR code]
+     * @param  string $secretCode [The secret code entered by the user for
+     * authentication]
+     *
+     * @return object
+     */
 	public function verify(string $secretKey, string $secretCode): object
     {
         $validation = (bool) $this->google2FA->verifyKey($secretKey, $secretCode);

tests/Auth2FATest.php

@@ -16,13 +16,13 @@ class Auth2FATest extends Test
     protected function setUp(): void
     {
         $this->auth2FA = new Auth2FA();
+
+        $this->initReflection($this->auth2FA);
     }
 
     public function testConstruct(): void
     {
-        $this->initReflection($this->auth2FA);
-
-        $this->assertInstanceOf(Google2FA::class, $this->getPrivateProperty(Constanst::PROPIERTY));
+        $this->assertInstanceOf(Google2FA::class, $this->getPrivateProperty('google2FA'));
     }
 
     public function testQr(): void

tests/Constanst.php

@@ -6,7 +6,6 @@
 
 class Constanst
 {
-    const PROPIERTY = 'google2FA';
     const STATUS = 'status';
     const MESSAGE = 'message';
     const DATA = 'data';