feat: Add admin management endpoints

CHANGELOG.md

@@ -3,6 +3,8 @@
 ## Unreleased
 ### Added
 - docs: Added license
+- feat: Add admin management endpoints
+- feat: Add config to setup default admin accounts
 
 ### Changed
 - chore: Update dependencies

config.yaml

@@ -27,3 +27,6 @@ images:
     - png
     - jpg
 
+admin:
+  defaultList:
+    - abc@gmail.com

docs/configs.md

@@ -73,3 +73,15 @@ images:
 - `images.maxImagesPerComment` : *(Env variable : `IMAGE_MAX_IMAGES_PER_COMMENT`)* - Max number of images per comment
 - `images.maxSize` : *(Env variable : `IMAGE_MAX_SIZE`)* - Image max site in bytes
 - `images.acceptedExtensions` : List of file extensions allowed for file update.
+
+
+---
+
+## Admin
+```yaml
+admin:
+  defaultList:
+```
+
+### Parameters
+- `admin.defaultList` : List of default administrator of the Iris instance

docs/openapi.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.3
 info:
   title: Iris API
   description: API to manage ideas, votes, and comments.
-  version: 1.0.0
+  version: 1.1.0
 servers:
   - url: https://api.example.com
     description: Production server (example)
@@ -11,6 +11,52 @@ servers:
 security:
   - bearerAuth: []
 paths:
+  /v1/admin:
+    get:
+      summary: Get all the admin in database
+      description: Returns the list of admins
+      tags: [Admin]
+      responses:
+        '200':
+          description: Admin list
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Admin'
+        default:
+          $ref: '#/components/responses/ErrorResponse'
+    post:
+      summary: Add an admin
+      description: Add an user to the admin list
+      tags: [Admin]
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Admin'
+      responses:
+        '200':
+          description: Admin added
+        default:
+          $ref: '#/components/responses/ErrorResponse'
+    delete:
+      summary: Remove an admin
+      description: Remove an user to the admin list
+      tags: [Admin]
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Admin'
+      responses:
+        '200':
+          description: Admin removed
+        default:
+          $ref: '#/components/responses/ErrorResponse'
   /v1/admin/me:
     get:
       summary: Check if the connected user is an admin
@@ -352,6 +398,11 @@ components:
           schema:
             $ref: '#/components/schemas/EnhancedError'
   schemas:
+    Admin:
+        type: object
+        properties:
+          user_email:
+            type: string
     Links:
       type: object
       properties:

pkg/apirouter/routes/v1/admin/admin_router.go

@@ -4,7 +4,11 @@ package admin
 import (
 	"fmt"
 	"github.com/RoadTripMoustache/iris_api/pkg/apirouter/middlewares"
+	apiUtils "github.com/RoadTripMoustache/iris_api/pkg/apirouter/utils"
 	ctrl "github.com/RoadTripMoustache/iris_api/pkg/controllers/admin"
+	"github.com/RoadTripMoustache/iris_api/pkg/enum"
+	"github.com/RoadTripMoustache/iris_api/pkg/errors"
+	adminsvc "github.com/RoadTripMoustache/iris_api/pkg/services/admin"
 	"github.com/gorilla/mux"
 	"net/http"
 )
@@ -25,6 +29,51 @@ func New(router *mux.Router, parentPath string) *AdminRouter {
 
 // InitRoutes initializes the routes for the admin API.
 func (p *AdminRouter) InitRoutes() {
+	// Get the admin list
+	middlewares.AddRoute(
+		p.MuxRouter,
+		http.MethodGet,
+		p.Path,
+		http.StatusOK,
+		func(ctx apiUtils.Context) ([]byte, *errors.EnhancedError) {
+			adm, e := adminsvc.GetAdmin(ctx, ctx.UserEmail)
+			if e != nil || adm == nil {
+				return nil, errors.New(enum.AuthUnauthorized, nil)
+			}
+
+			return ctrl.GetAdmins(ctx)
+		},
+	)
+	// Add an user as an admin
+	middlewares.AddRoute(
+		p.MuxRouter,
+		http.MethodPost,
+		p.Path,
+		http.StatusOK,
+		func(ctx apiUtils.Context) ([]byte, *errors.EnhancedError) {
+			adm, e := adminsvc.GetAdmin(ctx, ctx.UserEmail)
+			if e != nil || adm == nil {
+				return nil, errors.New(enum.AuthUnauthorized, nil)
+			}
+
+			return ctrl.AddAdmin(ctx)
+		},
+	)
+	// Remove an user as an admin
+	middlewares.AddRoute(
+		p.MuxRouter,
+		http.MethodDelete,
+		p.Path,
+		http.StatusOK,
+		func(ctx apiUtils.Context) ([]byte, *errors.EnhancedError) {
+			adm, e := adminsvc.GetAdmin(ctx, ctx.UserEmail)
+			if e != nil || adm == nil {
+				return nil, errors.New(enum.AuthUnauthorized, nil)
+			}
+
+			return ctrl.RemoveAdmin(ctx)
+		},
+	)
 	// Check if current user is admin
 	middlewares.AddRoute(
 		p.MuxRouter,

pkg/config/admin_models.go

@@ -0,0 +1,5 @@
+package config
+
+type AdminConfig struct {
+	DefaultList []string `yaml:"defaultList"`
+}

pkg/config/models.go

@@ -6,4 +6,5 @@ type Config struct {
 	Database DatabaseConfig `yaml:"database"`
 	Server   ServerConfig   `yaml:"server"`
 	Images   ImageConfig    `yaml:"images"`
+	Admin    AdminConfig    `yaml:"admin"`
 }

pkg/controllers/admin/add_admin.go

@@ -0,0 +1,31 @@
+// Package admin contains all the functions exposed by the Admin controller.
+package admin
+
+import (
+	apiUtils "github.com/RoadTripMoustache/iris_api/pkg/apirouter/utils"
+	"github.com/RoadTripMoustache/iris_api/pkg/controllers/utils"
+	"github.com/RoadTripMoustache/iris_api/pkg/dbmodels/admin"
+	"github.com/RoadTripMoustache/iris_api/pkg/enum"
+	"github.com/RoadTripMoustache/iris_api/pkg/errors"
+	adminsvc "github.com/RoadTripMoustache/iris_api/pkg/services/admin"
+)
+
+// AddAdmin - Add an user as admin
+func AddAdmin(ctx apiUtils.Context) ([]byte, *errors.EnhancedError) {
+	payload := admin.Admin{}
+	if err := utils.BodyFormatter(ctx.Body, &payload); err != nil {
+		return nil, errors.New(enum.BadRequest, err)
+	}
+
+	adm, _ := adminsvc.GetAdmin(ctx, payload.UserEmail)
+	if adm != nil {
+		return utils.PrepareResponse(nil)
+	}
+
+	e := adminsvc.AddAdmin(ctx, payload.UserEmail)
+	if e != nil {
+		return nil, e
+	}
+
+	return utils.PrepareResponse(nil)
+}

pkg/controllers/admin/get_admins.go

@@ -0,0 +1,18 @@
+// Package admin contains all the functions exposed by the Admin controller.
+package admin
+
+import (
+	apiUtils "github.com/RoadTripMoustache/iris_api/pkg/apirouter/utils"
+	"github.com/RoadTripMoustache/iris_api/pkg/controllers/utils"
+	"github.com/RoadTripMoustache/iris_api/pkg/errors"
+	adminsvc "github.com/RoadTripMoustache/iris_api/pkg/services/admin"
+)
+
+// GetAdmins returns the list of admins
+func GetAdmins(ctx apiUtils.Context) ([]byte, *errors.EnhancedError) {
+	admList, e := adminsvc.GetAdmins(ctx)
+	if e != nil {
+		return nil, e
+	}
+	return utils.PrepareResponse(admList)
+}

pkg/controllers/admin/is_admin.go

@@ -11,10 +11,10 @@ import (
 
 // IsCurrentUserAdmin returns whether the authenticated user is an admin.
 func IsCurrentUserAdmin(ctx apiUtils.Context) ([]byte, *errors.EnhancedError) {
-	if ctx.UserID == "" {
+	if ctx.UserEmail == "" {
 		return nil, errors.New(enum.AuthUnauthorized, nil)
 	}
-	adm, e := adminsvc.GetAdmin(ctx, ctx.UserID)
+	adm, e := adminsvc.GetAdmin(ctx, ctx.UserEmail)
 	if e != nil {
 		return nil, e
 	}

pkg/controllers/admin/remove_admin.go

@@ -0,0 +1,31 @@
+// Package admin contains all the functions exposed by the Admin controller.
+package admin
+
+import (
+	apiUtils "github.com/RoadTripMoustache/iris_api/pkg/apirouter/utils"
+	"github.com/RoadTripMoustache/iris_api/pkg/controllers/utils"
+	"github.com/RoadTripMoustache/iris_api/pkg/enum"
+	"github.com/RoadTripMoustache/iris_api/pkg/errors"
+	"github.com/RoadTripMoustache/iris_api/pkg/models/admin"
+	adminsvc "github.com/RoadTripMoustache/iris_api/pkg/services/admin"
+)
+
+// RemoveAdmin - Remove an user from the admin list
+func RemoveAdmin(ctx apiUtils.Context) ([]byte, *errors.EnhancedError) {
+	payload := admin.Admin{}
+	if err := utils.BodyFormatter(ctx.Body, &payload); err != nil {
+		return nil, errors.New(enum.BadRequest, err)
+	}
+
+	adm, _ := adminsvc.GetAdmin(ctx, payload.UserEmail)
+	if adm == nil {
+		return utils.PrepareResponse(nil)
+	}
+
+	e := adminsvc.DeleteAdmin(ctx, payload.UserEmail)
+	if e != nil {
+		return nil, e
+	}
+
+	return utils.PrepareResponse(nil)
+}

pkg/dbmodels/admin/admin.go

@@ -8,16 +8,16 @@ import (
 
 const (
 	AdminCollectionName string = "admins"
-	AdminUserIDLabel    string = "user_id"
+	AdminUserEmailLabel string = "user_email"
 )
 
 type Admin struct {
-	UserID string `json:"user_id"`
+	UserEmail string `json:"user_email"`
 }
 
 func (a *Admin) ToMap() map[string]interface{} {
 	return map[string]interface{}{
-		"user_id": a.UserID,
+		"user_email": a.UserEmail,
 	}
 }
 
@@ -31,7 +31,7 @@ func AdminFromMap(m map[string]interface{}) *Admin {
 
 func ToAdminModel(admin Admin) models.Admin {
 	modelAdmin := models.Admin{
-		UserID: admin.UserID,
+		UserEmail: admin.UserEmail,
 	}
 
 	return modelAdmin

pkg/dbmodels/admin/data_test.go

@@ -6,14 +6,14 @@ import (
 
 var (
 	adminMap = map[string]interface{}{
-		"user_id": "titiU",
+		"user_email": "titiU",
 	}
 
 	admin = Admin{
-		UserID: "titiU",
+		UserEmail: "titiU",
 	}
 
 	adminModel = models.Admin{
-		UserID: "titiU",
+		UserEmail: "titiU",
 	}
 )

pkg/mocks/services/admin/mock_admin_management_service.go

@@ -13,8 +13,8 @@ type MockAdminManagementService struct {
 	mock.Mock
 }
 
-func (m *MockAdminManagementService) GetAdmin(ctx utils.Context, userID string) (*dbmodels.Admin, *errors.EnhancedError) {
-	args := m.Called(ctx, userID)
+func (m *MockAdminManagementService) GetAdmin(ctx utils.Context, userEmail string) (*dbmodels.Admin, *errors.EnhancedError) {
+	args := m.Called(ctx, userEmail)
 	var activity *dbmodels.Admin
 	if args.Get(0) != nil {
 		activity = args.Get(0).(*dbmodels.Admin)
@@ -39,17 +39,17 @@ func (m *MockAdminManagementService) GetAdmins(ctx utils.Context) ([]*dbmodels.A
 	return admins, enhancedError
 }
 
-func (m *MockAdminManagementService) AddAdmin(ctx utils.Context, userID string) *errors.EnhancedError {
-	args := m.Called(ctx, userID)
+func (m *MockAdminManagementService) AddAdmin(ctx utils.Context, userEmail string) *errors.EnhancedError {
+	args := m.Called(ctx, userEmail)
 	var enhancedError *errors.EnhancedError
 	if args.Get(0) != nil {
 		enhancedError = args.Get(0).(*errors.EnhancedError)
 	}
 	return enhancedError
 }
 
-func (m *MockAdminManagementService) DeleteAdmin(ctx utils.Context, userID string) *errors.EnhancedError {
-	args := m.Called(ctx, userID)
+func (m *MockAdminManagementService) DeleteAdmin(ctx utils.Context, userEmail string) *errors.EnhancedError {
+	args := m.Called(ctx, userEmail)
 	var enhancedError *errors.EnhancedError
 	if args.Get(0) != nil {
 		enhancedError = args.Get(0).(*errors.EnhancedError)

pkg/models/admin/admin.go

@@ -2,5 +2,5 @@
 package admin
 
 type Admin struct {
-	UserID string `json:"user_id"`
+	UserEmail string `json:"user_email"`
 }