✨ Added authentication example

Author: mychidarko

App/Controllers/Auth/AccountController.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace App\Controllers\Auth;
+
+use Leaf\Auth;
+
+class AccountController extends Controller
+{
+    public function user()
+    {
+        // The second parameter holds items to hide from the user array.
+        $user = Auth::user("users", ["password"]);
+
+        if (!$user) throwErr(Auth::errors());
+
+        json($user);
+    }
+
+    public function update()
+    {
+        $userId = Auth::id();
+
+        $data = request(["username", "email", "name"]);
+        $dataKeys = array_keys($data);
+
+        $where = ["id" => $userId];
+
+        $uniques = ["username", "email"];
+
+        // This part simply removes empty fields from request
+        foreach ($dataKeys as $key) {
+            if (!$data[$key]) {
+                unset($data[$key]);
+                continue;
+            }
+
+            if (!strlen($data[$key])) {
+                unset($data[$key]);
+            }
+        }
+
+        // This section removes all uniques not found in request
+        foreach ($uniques as $key => $unique) {
+            if (!isset($data[$unique])) {
+                unset($uniques[$key]);
+            }
+        }
+
+        $user = Auth::update("users", $data, $where, $uniques);
+
+        if (!$user) throwErr(Auth::errors());
+
+        json($user);
+    }
+}

App/Controllers/Auth/Controller.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace App\Controllers\Auth;
+
+/**
+ * This is a base controller for the auth namespace
+ */
+class Controller extends \App\Controllers\Controller
+{
+    //
+}

App/Controllers/Auth/LoginController.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace App\Controllers\Auth;
+
+use Leaf\Auth;
+use Leaf\Form;
+
+class LoginController extends Controller
+{
+    public function index()
+    {
+        list($username, $password) = requestData(["username", "password"], true, true);
+
+        // You can now call leaf form methods statically.
+        // Leaf v2.4.2 includes a new rule method which allows you to create
+        // your own form rules
+        Form::rule("max", function($field, $value, $params) {
+            if (strlen($value) > $params) {
+                Form::addError($field, "$field can't be more than $params characters");
+                return false;
+            }
+        });
+
+        // You can also pass in custom parameters into your
+        // form rules. The example below calls the max rule defined
+        // above, and replaces the $params variable with 10.
+        $validation = Form::validate([
+            // To pass a param to a rule, just use :
+            "username" => "max:15",
+            "password" => "min:8",
+        ]);
+
+        // if validation fails, throw the errors
+        if (!$validation) throwErr(Form::errors());
+
+        // Simple logins with leaf auth. It takes in the table
+        // to search for users in and the credentials to check
+        $user = Auth::login("users", [
+            "username" => $username,
+            "password" => $password
+        ]);
+
+        // If user isn't found, show some errors
+        if (!$user) throwErr(Auth::errors());
+
+        json($user);
+    }
+
+    public function logout()
+    {
+        // If you use session with your tokens, you
+        // might want to remove all the saved data here
+        json("Logged out successfully!");
+    }
+}

App/Controllers/Auth/RegisterController.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace App\Controllers\Auth;
+
+use Leaf\Auth;
+use Leaf\Form;
+
+class RegisterController extends Controller
+{
+    public function store()
+    {
+        $credentials = request(["username", "email", "password"]);
+
+        $validation = Form::validate([
+            "username" => ["username", "max:15"],
+            "email" => "email",
+            "password" => "min:8"
+        ]);
+
+        if (!$validation) throwErr(Form::errors());
+
+        $user = Auth::register("users", $credentials, [
+            "username", "email"
+        ]);
+
+        if (!$user) throwErr(Auth::errors());
+
+        json($user);
+    }
+}

App/Controllers/Controller.php

@@ -1,48 +1,35 @@
 <?php
+
 namespace App\Controllers;
 
 // Leaf Auth is a package which makes user authentication simple
 use Leaf\Auth;
-use Leaf\Helpers\Password;
 
 /**
  * This is the base controller for your Leaf API Project.
  * You can initialize packages or define methods here to use
  * them across all your other controllers which extend this one.
  */
-class Controller extends \Leaf\ApiController {
-	public $auth;
-
-	public function __construct() {
+class Controller extends \Leaf\ApiController
+{
+	public function __construct()
+	{
 		parent::__construct();
 
 		// In this version, request isn't initialised for you. You can use
 		// requestData() or request() to get request data or initialise it yourself
-		$this->auth = new Auth;
 
 		// autoConnect uses the .env variables to quickly connect to db
-		$this->auth->autoConnect();
-		
+		Auth::autoConnect();
+
 		// set default token expiry time
-		$this->auth->tokenLifetime(60 * 60 * 24 * 365);
+		Auth::tokenLifetime(60 * 60 * 24 * 365);
 
 		// You can configure auth to get additional customizations
-		$this->auth->config("LOGIN_PARAMS_ERROR", "Username not registered!");
-
-		// Password encode is run when leaf wants to encode passwords on register
-		// This exact method is used by default in Leaf, so you can delete it if
-		// you want to.
-		$this->auth->config("PASSWORD_ENCODE", function ($password) {
-			return Password::hash($password);
-		});
-
-		// this function is run to verify the password. It's done by default,
-		// so you can remove this line and the above line if you wish to.
-		$this->auth->config("PASSWORD_VERIFY", function ($password, $hashedPassword) {
-			// Inside the password_verify method, you have access to the password and the hashed password
-			return Password::verify($password, $hashedPassword);
-		});
-
-		// You can refer to https://leafphp.netlify.app/#/leaf/v/2.4/core/auth for auth docs
-    }
+		// This can be done here with the Auth::config method or
+		// simply in the Config/auth.php file
+		Auth::config(AuthConfig());
+
+		// You can refer to https://leafphp.netlify.app/#/leaf/v/2.5/core/auth for auth docs
+	}
 }

App/Routes/_auth.php

@@ -0,0 +1,13 @@
+<?php
+
+$app->group("/auth", function () use ($app) {
+    $app->post("/login", "Auth\LoginController@index");
+    $app->post("/register", "Auth\RegisterController@store");
+    $app->get("/logout", "Auth\LoginController@logout");
+    // Reset and recover account will be added later
+});
+
+$app->group("/user", function () use ($app) {
+    $app->get("/", "Auth\AccountController@user");
+    $app->post("/update", "Auth\AccountController@update");
+});

App/Routes/_users.php

@@ -40,4 +40,8 @@
 
 // You can define your routes here directly or
 // import an independent route file
-require "_users.php";
+
+// Example authentication has been created for you to give you
+// an idea on working with this version of leaf. To get rid of all
+// the comments, simply run php leaf scaffold:auth --api
+require __DIR__ . "/_auth.php";

App/Routes/index.php

@@ -14,5 +14,5 @@
         "commands_path" => "/App/Console",
         "routes_path" => "/App/Routes",
         "lib_path" => "/Lib",
-    ]
+    ],
 ];