Feature: invite user by email

.gitignore

@@ -4,4 +4,10 @@ ml/data/test_images
 node_modules
 ui/out
 __debug_bin*
-api/__debug_bin*
+api/.env.local
+api/__debug_bin*
+ui/yarn.lock
+api/.env
+ui/.env.local
+ui/.env.local
+*.local

README.md

@@ -42,6 +42,9 @@ The front-end makes use of the [Next.js](https://nextjs.org/) framework. [Storyb
 
 The back-end or API is written in Golang, and defines specific methods to persist data and call the face recognition model. It has various API methods to create new users, assign permissions and access control, and (re)train and interfere with the facial recognition model.
 
+  - Swagger API is hosted at http://localhost:80/swagger/index.html
+  - Postman Collection [can be found here](https://kerberosio.postman.co/workspace/UUG.AI~52218588-948a-49a0-8046-34f96285bd19/collection/5538769-9f1fc117-a30b-4acf-a7f4-e7ca1ebe5d6f?action=share&creator=5538769)
+
 ## ML (face recognition)
 
 To be documented

api/.vscode/launch.json

@@ -4,8 +4,6 @@
   // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
   "version": "0.2.0",
   "configurations": [
-
-
     {
       "name": "Launch Package",
       "type": "go",

api/controllers/email.go

@@ -0,0 +1,85 @@
+package controllers
+
+import (
+	"log"
+	"os"
+
+	"github.com/uug-ai/facial-access-control/api/models"
+	"github.com/uug-ai/facial-access-control/api/notifications"
+)
+
+type Email struct {
+	Type    string
+	Mailgun notifications.Mail
+	SMTP    notifications.SMTP
+}
+
+func (email Email) Send(m notifications.Message) {
+	if email.Type == "mailgun" {
+		err := email.Mailgun.Send(m) // TODO add error handler
+		if err != nil {
+			log.Println(err)
+		}
+	} else if email.Type == "smtp" {
+		err := email.SMTP.Send(m) // TODO add error handler
+		if err != nil {
+			log.Println(err)
+		}
+	}
+}
+
+func Mail(mailto string, template string) *Email {
+	emailProvider := os.Getenv("MAIL_PROVIDER")
+	if emailProvider == "" {
+		emailProvider = "mailgun"
+	}
+	var email Email
+	if emailProvider == "mailgun" {
+		mailgun := notifications.Mail{
+			Domain:     os.Getenv("MAILGUN_DOMAIN"),
+			ApiKey:     os.Getenv("MAILGUN_API_KEY"),
+			EmailFrom:  os.Getenv("EMAIL_FROM"),
+			EmailTo:    mailto,
+			TemplateId: template,
+		}
+		email.Type = "mailgun"
+		email.Mailgun = mailgun
+	} else if emailProvider == "smtp" {
+		smtp := notifications.SMTP{
+			Server:     os.Getenv("SMTP_SERVER"),
+			Port:       os.Getenv("SMTP_PORT"),
+			Username:   os.Getenv("SMTP_USERNAME"),
+			Password:   os.Getenv("SMTP_PASSWORD"),
+			EmailFrom:  os.Getenv("EMAIL_FROM"),
+			EmailTo:    mailto,
+			TemplateId: template,
+		}
+		email.Type = "smtp"
+		email.SMTP = smtp
+	}
+	return &email
+}
+
+func SendWelcomeEmail(user models.User, m notifications.Message) {
+	m.Title = os.Getenv("WELCOME_TITLE")
+	email := Mail(user.Email, os.Getenv("WELCOME_TEMPLATE"))
+	email.Send(m)
+}
+
+func SendShareEmail(user models.User, m notifications.Message) {
+	m.Title = os.Getenv("SHARE_TITLE")
+	email := Mail(user.Email, os.Getenv("SHARE_TEMPLATE"))
+	email.Send(m) // TODO add error handler
+}
+
+func SendActivationEmail(user models.User, m notifications.Message) {
+	m.Title = os.Getenv("ACTIVATE_TITLE")
+	email := Mail(user.Email, os.Getenv("ACTIVATE_TEMPLATE"))
+	email.Send(m) // TODO add error handler
+}
+
+func SendForgotEmail(user models.User, m notifications.Message) {
+	m.Title = os.Getenv("FORGOT_TITLE")
+	email := Mail(user.Email, os.Getenv("FORGOT_TEMPLATE"))
+	email.Send(m) // TODO add error handler
+}