agecem/bottin-agenda
5
0
Fork 0
Code Issues 2 Pull requests Projects Releases Packages Wiki Activity

Implémenter client web #19

Merged
vlbeaudoin merged 4 commits from feature/web into main 2023-06-10 00:10:26 -04:00
Conversation 0 Commits 4 Files changed 10 +431 -56
8 changed files with 431 additions and 56 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit c850b221a1 - Show all commits

56
cmd/api.go
View file

@ -93,60 +93,4 @@ var apiCmd = &cobra.Command{
func init() {
rootCmd.AddCommand(apiCmd)
// api.key
apiCmd.Flags().String(
"api-key", "bottin-agenda",
"API server key. Leave empty for no key auth. (config: 'api.key')")
viper.BindPFlag("api.key", apiCmd.Flags().Lookup("api-key"))
// api.port
apiCmd.Flags().Int(
"api-port", 1313,
"API server port (config:'api.port')")
viper.BindPFlag("api.port", apiCmd.Flags().Lookup("api-port"))
// bottin.api.host
apiCmd.Flags().String(
"bottin-api-host", "api",
"Remote bottin API server host (config:'bottin.api.host')")
viper.BindPFlag("bottin.api.host", apiCmd.Flags().Lookup("bottin-api-host"))
// bottin.api.key
apiCmd.Flags().String(
"bottin-api-key", "bottin",
"Remote bottin API server key (config:'bottin.api.key')")
viper.BindPFlag("bottin.api.key", apiCmd.Flags().Lookup("bottin-api-key"))
// bottin.api.protocol
apiCmd.Flags().String(
"bottin-api-protocol", "http",
"Remote bottin API server protocol (config:'bottin.api.protocol')")
viper.BindPFlag("bottin.api.protocol", apiCmd.Flags().Lookup("bottin-api-protocol"))
// bottin.api.port
apiCmd.Flags().Int(
"bottin-api-port", 1312,
"Remote bottin API server port (config:'bottin.api.port')")
viper.BindPFlag("bottin.api.port", apiCmd.Flags().Lookup("bottin-api-port"))
// db.database
apiCmd.Flags().String("db-database", "bottin-agenda", "Postgres database (config:'db.database')")
viper.BindPFlag("db.database", apiCmd.Flags().Lookup("db-database"))
// db.host
apiCmd.Flags().String("db-host", "db", "Postgres host (config:'db.host')")
viper.BindPFlag("db.host", apiCmd.Flags().Lookup("db-host"))
// db.password
apiCmd.Flags().String("db-password", "bottin-agenda", "Postgres password (config:'db.password')")
viper.BindPFlag("db.password", apiCmd.Flags().Lookup("db-password"))
// db.port
apiCmd.Flags().Int("db-port", 5432, "Postgres port (config:'db.port')")
viper.BindPFlag("db.port", apiCmd.Flags().Lookup("db-port"))
// db.user
apiCmd.Flags().String("db-user", "bottin-agenda", "Postgres user (config:'db.user')")
viper.BindPFlag("db.user", apiCmd.Flags().Lookup("db-user"))
}

98
cmd/root.go
View file

@ -29,6 +29,104 @@ func init() {
cobra.OnInitialize(initConfig)
rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.bottin-agenda.yaml)")
// web.api.host
rootCmd.PersistentFlags().String(
"web-api-host", "api",
"Remote API server host (config:'web.api.host')")
viper.BindPFlag("web.api.host", rootCmd.PersistentFlags().Lookup("web-api-host"))
// web.api.key
rootCmd.PersistentFlags().String(
"web-api-key", "bottin-agenda",
"Remote API server key (config:'web.api.key')")
viper.BindPFlag("web.api.key", rootCmd.PersistentFlags().Lookup("web-api-key"))
// web.api.protocol
rootCmd.PersistentFlags().String(
"web-api-protocol", "http",
"Remote API server protocol (config:'web.api.protocol')")
viper.BindPFlag("web.api.protocol", rootCmd.PersistentFlags().Lookup("web-api-protocol"))
// web.api.port
rootCmd.PersistentFlags().Int(
"web-api-port", 1313,
"Remote API server port (config:'web.api.port')")
viper.BindPFlag("web.api.port", rootCmd.PersistentFlags().Lookup("web-api-port"))
// web.password
rootCmd.PersistentFlags().String(
"web-password", "bottin-agenda",
"Web client password (config:'web.password')")
viper.BindPFlag("web.password", rootCmd.PersistentFlags().Lookup("web-password"))
// web.port
rootCmd.PersistentFlags().Int(
"web-port", 2313,
"Web client port (config:'web.port')")
viper.BindPFlag("web.port", rootCmd.PersistentFlags().Lookup("web-port"))
// web.user
rootCmd.PersistentFlags().String(
"web-user", "bottin-agenda",
"Web client user (config:'web.user')")
viper.BindPFlag("web.user", rootCmd.PersistentFlags().Lookup("web-user"))
// api.key
rootCmd.PersistentFlags().String(
"api-key", "bottin-agenda",
"API server key. Leave empty for no key auth. (config: 'api.key')")
viper.BindPFlag("api.key", rootCmd.PersistentFlags().Lookup("api-key"))
// api.port
rootCmd.PersistentFlags().Int(
"api-port", 1313,
"API server port (config:'api.port')")
viper.BindPFlag("api.port", rootCmd.PersistentFlags().Lookup("api-port"))
// bottin.api.host
rootCmd.PersistentFlags().String(
"bottin-api-host", "api",
"Remote bottin API server host (config:'bottin.api.host')")
viper.BindPFlag("bottin.api.host", rootCmd.PersistentFlags().Lookup("bottin-api-host"))
// bottin.api.key
rootCmd.PersistentFlags().String(
"bottin-api-key", "bottin",
"Remote bottin API server key (config:'bottin.api.key')")
viper.BindPFlag("bottin.api.key", rootCmd.PersistentFlags().Lookup("bottin-api-key"))
// bottin.api.protocol
rootCmd.PersistentFlags().String(
"bottin-api-protocol", "http",
"Remote bottin API server protocol (config:'bottin.api.protocol')")
viper.BindPFlag("bottin.api.protocol", rootCmd.PersistentFlags().Lookup("bottin-api-protocol"))
// bottin.api.port
rootCmd.PersistentFlags().Int(
"bottin-api-port", 1312,
"Remote bottin API server port (config:'bottin.api.port')")
viper.BindPFlag("bottin.api.port", rootCmd.PersistentFlags().Lookup("bottin-api-port"))
// db.database
rootCmd.PersistentFlags().String("db-database", "bottin-agenda", "Postgres database (config:'db.database')")
viper.BindPFlag("db.database", rootCmd.PersistentFlags().Lookup("db-database"))
// db.host
rootCmd.PersistentFlags().String("db-host", "db", "Postgres host (config:'db.host')")
viper.BindPFlag("db.host", rootCmd.PersistentFlags().Lookup("db-host"))
// db.password
rootCmd.PersistentFlags().String("db-password", "bottin-agenda", "Postgres password (config:'db.password')")
viper.BindPFlag("db.password", rootCmd.PersistentFlags().Lookup("db-password"))
// db.port
rootCmd.PersistentFlags().Int("db-port", 5432, "Postgres port (config:'db.port')")
viper.BindPFlag("db.port", rootCmd.PersistentFlags().Lookup("db-port"))
// db.user
rootCmd.PersistentFlags().String("db-user", "bottin-agenda", "Postgres user (config:'db.user')")
viper.BindPFlag("db.user", rootCmd.PersistentFlags().Lookup("db-user"))
}
// initConfig reads in config file and ENV variables if set.

90
cmd/web.go Normal file
View file

@ -0,0 +1,90 @@
package cmd
import (
"crypto/subtle"
"embed"
"fmt"
"html/template"
"io"
"log"
"git.agecem.com/agecem/bottin-agenda/data"
"git.agecem.com/agecem/bottin-agenda/models"
"git.agecem.com/agecem/bottin-agenda/web"
"git.agecem.com/agecem/bottin-agenda/web/webhandlers"
"github.com/labstack/echo/v4"
"github.com/labstack/echo/v4/middleware"
"github.com/spf13/cobra"
"github.com/spf13/viper"
)
var templatesFS embed.FS
type Template struct {
templates *template.Template
}
func (t *Template) Render(w io.Writer, name string, data interface{}, c echo.Context) error {
return t.templates.ExecuteTemplate(w, name, data)
}
// webCmd represents the web command
var webCmd = &cobra.Command{
Use: "web",
Short: "Démarrer le client web",
Args: cobra.ExactArgs(0),
Run: func(cmd *cobra.Command, args []string) {
var config models.Config
err := viper.Unmarshal(&config)
if err != nil {
log.Fatalf("Error during webCmd#viper.Unmarshal(): %s", err)
}
// Ping API server
apiClient := data.NewApiClient(config.Web.Api.Key, config.Web.Api.Host, config.Web.Api.Protocol, config.Web.Api.Port)
healthResult, err := apiClient.GetHealth()
if err != nil {
log.Fatalf("Error during webCmd#apiClient.GetHealth(): %s", err)
}
log.Println(healthResult)
e := echo.New()
// Middlewares
e.Pre(middleware.AddTrailingSlash())
e.Use(middleware.BasicAuth(func(user, password string, c echo.Context) (bool, error) {
usersMatch := subtle.ConstantTimeCompare([]byte(user), []byte(config.Web.User)) == 1
passwordsMatch := subtle.ConstantTimeCompare([]byte(password), []byte(config.Web.Password)) == 1
return usersMatch && passwordsMatch, nil
}))
// Template
t := &Template{
templates: template.Must(template.ParseFS(templatesFS, "templates/*.html")),
}
e.Renderer = t
// Routes
e.GET("/", webhandlers.GetIndex)
//e.POST("/transaction", webhandlers.PostTransaction)
// Execution
e.Logger.Fatal(e.Start(
fmt.Sprintf(":%d", config.Web.Port)))
},
}
func init() {
rootCmd.AddCommand(webCmd)
templatesFS = web.GetTemplates()
}

32
data/apiclient.go
View file

@ -1,9 +1,14 @@
package data
import (
"encoding/json"
"errors"
"fmt"
"io"
"io/ioutil"
"net/http"
"git.agecem.com/agecem/bottin-agenda/responses"
)
type ApiClient struct {
@ -58,3 +63,30 @@ func (a *ApiClient) Call(method, route string, requestBody io.Reader, useKey boo
return response, nil
}
// GetHealth allows checking for API server health
func (a *ApiClient) GetHealth() (string, error) {
var response responses.GetHealthResponse
getHealthResponse, err := a.Call(http.MethodGet, "/v3/health", nil, true)
if err != nil {
return response.Message, err
}
defer getHealthResponse.Body.Close()
body, err := ioutil.ReadAll(getHealthResponse.Body)
if err != nil {
return response.Message, err
}
if err := json.Unmarshal(body, &response); err != nil {
return response.Message, err
}
if response.Message == "" {
return response.Message, errors.New("Could not confirm that API server is up, no response message")
}
return response.Message, nil
}

41
models/models.go
View file

@ -17,3 +17,44 @@ type Transaction struct {
GivenAt *time.Time `db:"given_at" json:"given_at"`
IsPerpetual bool `db:"is_perpetual" json:"is_perpetual"`
}
type Config struct {
Web WebConfig `json:"web"`
Api ApiConfig `json:"api"`
Bottin BottinConfig `json:"bottin"`
Db DbConfig `json:"db"`
}
type ApiConfig struct {
Key string `json:"key"`
Port int `json:"port"`
}
type BottinConfig struct {
Api struct {
Host string `json:"host"`
Key string `json:"key"`
Protocol string `json:"protocol"`
Port int `json:"port"`
} `json:"api"`
}
type DbConfig struct {
Database string `json:"database"`
Host string `json:"host"`
Password string `json:"password"`
Port int `json:"port"`
User string `json:"user"`
}
type WebConfig struct {
Api struct {
Host string `json:"host"`
Key string `json:"key"`
Port int `json:"port"`
Protocol string `json:"protocol"`
} `json:"api"`
Password string `json:"password"`
Port int `json:"port"`
User string `json:"user"`
}

10
web/embed.go Normal file
View file

@ -0,0 +1,10 @@
package web
import "embed"
//go:embed templates/*
var templatesFS embed.FS
func GetTemplates() embed.FS {
return templatesFS
}

117
web/templates/index.html Normal file
View file

@ -0,0 +1,117 @@
{{ define "index-html" }}
<!DOCTYPE html>
<html lang="fr">
<head>
<meta charset="utf-8">
<title>
AGECEM | Agenda
</title>
<style>
body {
/* Center the form on the page */
margin: 0 auto;
width: 400px;
/* Form outline */
padding: 1em;
border: 1px solid #ccc;
border-radius: 1em;
}
ul {
list-style: none;
padding: 0;
margin: 0;
}
form li + li {
margin-top: 1em;
}
label {
/* Uniform size & alignment */
display: inline-block;
width: 90px;
text-align: right;
}
input,
textarea {
/* To make sure that all text fields have the same font settings
By default, textareas have a monospace font */
font: 1em sans-serif;
/* Uniform text field size */
width: 300px;
box-sizing: border-box;
/* Match form field borders */
border: 1px solid #999;
}
input:focus,
textarea:focus {
/* Additional highlight for focused elements */
border-color: #000;
}
textarea {
/* Align multiline text fields with their labels */
vertical-align: top;
/* Provide space to type some text */
height: 5em;
}
.button {
/* Align buttons with the text fields */
padding-left: 90px; /* same size as the label elements */
}
button {
/* This extra margin represent roughly the same space as the space
between the labels and their text fields */
margin-left: 0.5em;
}
</style>
</head>
<body>
<h2>
Distribution d'agendas aux membres de l'AGECEM
</h2>
<p>
1) Si l'agenda demandé est perpétuel, cochez 'Perpétuel?:'<br>
<br>
2) Sélectionnez le champs 'Numéro étudiant:'<br>
<br>
3) Scannez la carte étudiante d'unE membre<br>
-ou-<br>
Entrez manuellement le code à 7 chiffres<br>
<br>
4) Si aucune erreur ne survient, la personne est libre de partir avec son agenda
</p>
<form action="/transaction" method="post">
<ul>
<li>
<label for="is_perpetual">Perpétuel?:</label>
<input type="checkbox" id="is_perpetual" name="is_perpetual"/>
</li>
<li>
<label for="membre_id">Numéro étudiant:</label>
<input type="text" id="membre_id" name="membre_id" autofocus/>
</li>
<li class="button">
<button type="submit">Scan</button>
</li>
</ul>
</form>
<p class="result">{{ .Result }}</p>
</body>
</html>
{{ end }}

43
web/webhandlers/handlers.go Normal file
View file

@ -0,0 +1,43 @@
package webhandlers
import (
"fmt"
"net/http"
"git.agecem.com/agecem/bottin/v5/data"
"github.com/labstack/echo/v4"
)
func GetIndex(c echo.Context) error {
return c.Render(http.StatusOK, "index-html", nil)
}
func GetMembre(c echo.Context) error {
apiClient := data.NewApiClientFromViper()
membreID := c.QueryParam("membre_id")
membre, err := apiClient.GetMembre(membreID)
if err != nil {
return c.Render(http.StatusBadRequest, "index-html", struct {
Result string
}{
Result: fmt.Sprintln("👎", err.Error()),
})
}
membreResult := fmt.Sprintf(`👍
Membre trouvéE: [%s]`, membre.ID)
if membre.PreferedName != "" {
membreResult = fmt.Sprintf("%s -> %s", membreResult, membre.PreferedName)
} else {
membreResult = fmt.Sprintf("%s -> %s, %s", membreResult, membre.LastName, membre.FirstName)
}
return c.Render(http.StatusOK, "index-html", struct {
Result string
}{
Result: membreResult,
})
}