Merge pull request #70 from System-Glitch/develop

v2.10.0

Author: System-Glitch

README.md

@@ -13,7 +13,7 @@
 
 <h2 align="center">An Elegant Golang Web Framework</h2>
 
-Goyave is a progressive and accessible web application framework, aimed at making development easy and enjoyable. It has a philosophy of cleanliness and conciseness to make programs more elegant, easier to maintain and more focused.
+Goyave is a progressive and accessible web application framework focused on APIs, aimed at making development easy and enjoyable. It has a philosophy of cleanliness and conciseness to make programs more elegant, easier to maintain and more focused.
 
 <table>
     <tr>
@@ -32,7 +32,7 @@ Goyave is a progressive and accessible web application framework, aimed at makin
     </tr>
 </table>
 
-Most golang frameworks for web development don't have a strong directory structure nor conventions to make applications have a uniform architecture and limit redundancy. This makes it difficult to work with them on different projects. In companies, having a well-defined and documented architecture helps new developers integrate projects faster, and reduces the time needed for maintaining them. For open source projects, it helps newcomers understanding the project and makes it easier to contribute.
+Most golang frameworks for web development don't have a strong directory structure nor conventions to make applications have a uniform architecture and limit redundancy. This makes it difficult to work with them on different projects. In companies, having a well-defined and documented architecture helps new developers integrate projects faster, and reduces the time needed for maintaining them. For open source projects, it helps newcomers understanding the project and makes it easier to contribute. With Goyave, expect a full package with minimum setup.
 
 ## Table of contents
 
@@ -102,6 +102,7 @@ This section's goal is to give a **brief** look at the main features of the fram
 - [Testing](#testing)
 - [Status handlers](#status-handlers)
 - [CORS](#cors)
+- [Authentication](#authentication)
 
 ### Hello world from scratch
 
@@ -111,7 +112,7 @@ The example below shows a basic `Hello world` application using Goyave.
 import "github.com/System-Glitch/goyave/v2"
 
 func registerRoutes(router *goyave.Router) {
-    router.Route("GET", "/hello", func(response *goyave.Response, request *goyave.Request) {
+    router.Get("/hello", func(response *goyave.Response, request *goyave.Request) {
         response.String(http.StatusOK, "Hello world!")
     }, nil)
 }
@@ -178,18 +179,18 @@ func Register(router *goyave.Router) {
     // Register your routes here
 
     // With closure, not recommended
-    router.Route("GET", "/hello", func(response *goyave.Response, r *goyave.Request) {
+    router.Get("GET", "/hello", func(response *goyave.Response, r *goyave.Request) {
         response.String(http.StatusOK, "Hi!")
     }, nil)
 
-    router.Route("GET", "/hello", myHandlerFunction, nil)
-    router.Route("POST", "/user", user.Register, userrequest.Register)
+    router.Get("/hello", myHandlerFunction, nil)
+    router.Post("/user", user.Register, userrequest.Register)
     router.Route("PUT|PATCH", "/user", user.Update, userrequest.Update)
     router.Route("POST", "/product", product.Store, productrequest.Store, middleware.Trim)
 }
 ```
 
-**Method signature:**
+**`Route` Method signature:**
 
 | Parameters                           | Return          |
 |--------------------------------------|-----------------|
@@ -204,9 +205,9 @@ URIs can have parameters, defined using the format `{name}` or `{name:pattern}`.
 
 **Example:**
 ``` go
-router.Route("GET", "/product/{key}", product.Show, nil)
-router.Route("GET", "/product/{id:[0-9]+}", product.ShowById, nil)
-router.Route("GET", "/category/{category}/{id:[0-9]+}", category.Show, nil)
+router.Get("/product/{key}", product.Show, nil)
+router.Get("/product/{id:[0-9]+}", product.ShowById, nil)
+router.Get("/category/{category}/{id:[0-9]+}", category.Show, nil)
 ```
 
 Route parameters can be retrieved as a `map[string]string` in handlers using the request's `Params` attribute.
@@ -339,7 +340,7 @@ var (
 Once your rules sets are defined, you need to assign them to your routes. The rule set for a route is the last parameter of the route definition.
 
 ``` go
-router.Route("POST", "/product", product.Store, productrequest.Store)
+router.Post("/product", product.Store, productrequest.Store)
 ```
 
 
@@ -596,6 +597,43 @@ router.CORS(options)
 
 **Learn more about CORS in the [documentation](https://system-glitch.github.io/goyave/guide/advanced/cors.html).**
 
+### Authentication
+
+Goyave provides a convenient and expandable way of handling authentication in your application. Authentication can be enabled when registering your routes:
+
+``` go
+import "github.com/System-Glitch/goyave/v2/auth"
+
+//...
+
+authenticator := auth.Middleware(&model.User{}, &auth.BasicAuthenticator{})
+router.Middleware(authenticator)
+```
+
+Authentication is handled by a simple middleware calling an **Authenticator**. This middleware also needs a model, which will be used to fetch user information on a successful login.
+
+Authenticators use their model's struct fields tags to know which field to use for username and password. To make your model compatible with authentication, you must add the `auth:"username"` and `auth:"password"` tags:
+
+``` go
+type User struct {
+	gorm.Model
+	Email    string `gorm:"type:varchar(100);unique_index" auth:"username"`
+	Name     string `gorm:"type:varchar(100)"`
+	Password string `gorm:"type:varchar(60)" auth:"password"`
+}
+```
+
+When a user is successfully authenticated on a protected route, its information is available in the controller handler, through the request `User` field.
+
+``` go
+func Hello(response *goyave.Response, request *goyave.Request) {
+	user := request.User.(*model.User)
+	response.String(http.StatusOK, "Hello " + user.Name)
+}
+```
+
+**Learn more about authentication in the [documentation](https://system-glitch.github.io/goyave/guide/advanced/authentication.html).**
+
 ## Contributing
 
 Thank you for considering contributing to the Goyave framework! You can find the contribution guide in the [documentation](https://system-glitch.github.io/goyave/guide/contribution-guide.html).

docs/404.html

@@ -0,0 +1,33 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Goyave</title>
+    <meta name="generator" content="VuePress 1.4.1">
+    <link rel="icon" type="image/png" sizes="16x16" href="/goyave/goyave_16.png">
+    <link rel="icon" type="image/png" sizes="32x32" href="/goyave/goyave_32.png">
+    <link rel="icon" type="image/png" sizes="64x64" href="/goyave/goyave_64.png">
+    <link rel="icon" type="image/png" sizes="128x128" href="/goyave/goyave_128.png">
+    <link rel="icon" type="image/png" sizes="256x256" href="/goyave/goyave_256.png">
+    <link rel="icon" type="image/png" sizes="512x512" href="/goyave/goyave_512.png">
+    <meta name="description" content="An Elegant Golang Web Framework">
+    <meta property="twitter:title" content="Goyave">
+    <meta property="twitter:description" content="An Elegant Golang Web Framework">
+    <meta property="twitter:image:src" content="https://system-glitch.github.io/goyave/goyave_banner.png">
+    <meta property="twitter:card" content="summary_large_image">
+    <meta property="og:title" content="Goyave">
+    <meta property="og:type" content="website">
+    <meta property="og:description" content="An Elegant Golang Web Framework">
+    <meta property="og:image" content="https://system-glitch.github.io/goyave/goyave_banner.png">
+    <meta property="og:site_name" content="Goyave">
+    <link rel="preload" href="/goyave/assets/css/0.styles.ae034a9f.css" as="style"><link rel="preload" href="/goyave/assets/js/app.ac32b3e6.js" as="script"><link rel="preload" href="/goyave/assets/js/4.f15bace1.js" as="script"><link rel="prefetch" href="/goyave/assets/js/10.97a5cc72.js"><link rel="prefetch" href="/goyave/assets/js/11.9bb90619.js"><link rel="prefetch" href="/goyave/assets/js/12.ee233449.js"><link rel="prefetch" href="/goyave/assets/js/13.9051c40a.js"><link rel="prefetch" href="/goyave/assets/js/14.1d0f4b69.js"><link rel="prefetch" href="/goyave/assets/js/15.aaf8265c.js"><link rel="prefetch" href="/goyave/assets/js/16.389b72fd.js"><link rel="prefetch" href="/goyave/assets/js/17.f30b8f75.js"><link rel="prefetch" href="/goyave/assets/js/18.d515c312.js"><link rel="prefetch" href="/goyave/assets/js/19.65053d4b.js"><link rel="prefetch" href="/goyave/assets/js/2.68c0af99.js"><link rel="prefetch" href="/goyave/assets/js/20.f033d601.js"><link rel="prefetch" href="/goyave/assets/js/21.9fff9bda.js"><link rel="prefetch" href="/goyave/assets/js/22.fb2c838d.js"><link rel="prefetch" href="/goyave/assets/js/23.35bd4881.js"><link rel="prefetch" href="/goyave/assets/js/24.a44a1d89.js"><link rel="prefetch" href="/goyave/assets/js/25.e1f32d08.js"><link rel="prefetch" href="/goyave/assets/js/26.02bdf651.js"><link rel="prefetch" href="/goyave/assets/js/27.8239d5ce.js"><link rel="prefetch" href="/goyave/assets/js/28.0e69ec47.js"><link rel="prefetch" href="/goyave/assets/js/29.b6d2bc3c.js"><link rel="prefetch" href="/goyave/assets/js/3.a002ba5f.js"><link rel="prefetch" href="/goyave/assets/js/30.d039792e.js"><link rel="prefetch" href="/goyave/assets/js/5.c89dd554.js"><link rel="prefetch" href="/goyave/assets/js/6.4e229a0d.js"><link rel="prefetch" href="/goyave/assets/js/7.1461637f.js"><link rel="prefetch" href="/goyave/assets/js/8.20e04508.js"><link rel="prefetch" href="/goyave/assets/js/9.61891602.js">
+    <link rel="stylesheet" href="/goyave/assets/css/0.styles.ae034a9f.css">
+  </head>
+  <body>
+    <div id="app" data-server-rendered="true"><div class="theme-container"><div class="theme-default-content"><h1>404</h1> <blockquote>That's a Four-Oh-Four.</blockquote> <a href="/goyave/" class="router-link-active">
+      Take me home.
+    </a></div></div><div class="global-ui"><!----></div></div>
+    <script src="/goyave/assets/js/app.ac32b3e6.js" defer></script><script src="/goyave/assets/js/4.f15bace1.js" defer></script>
+  </body>
+</html>