Add page for managing phone API keys

Author: AchoArnold

api/docs/docs.go

@@ -41,11 +41,55 @@ func NewPhoneAPIKeyHandler(
 // RegisterRoutes registers the routes for the PhoneAPIKeyHandler
 func (h *PhoneAPIKeyHandler) RegisterRoutes(app *fiber.App, middlewares ...fiber.Handler) {
 	router := app.Group("/v1/api-keys/")
+	router.Get("/", h.computeRoute(middlewares, h.Index)...)
 	router.Post("/", h.computeRoute(middlewares, h.Store)...)
 	router.Delete("/:phoneAPIKeyID", h.computeRoute(middlewares, h.Delete)...)
 	router.Delete("/:phoneAPIKeyID/phones/:phoneID", h.computeRoute(middlewares, h.DeletePhone)...)
 }
 
+// Index returns the phone API Keys of a user
+// @Summary      Get the phone API keys of a user
+// @Description  Get list phone API keys which a user has registered on the httpSMS application
+// @Security	 ApiKeyAuth
+// @Tags         PhoneAPIKeys
+// @Accept       json
+// @Produce      json
+// @Param        skip		query  int  	false	"number of heartbeats to skip"					minimum(0)
+// @Param        query		query  string  	false 	"filter api keys with name containing query"
+// @Param        limit		query  int  	false	"number of phone api keys to return"			minimum(1)	maximum(100)
+// @Success      200 		{object}	responses.PhoneAPIKeysResponse
+// @Failure      400		{object}	responses.BadRequest
+// @Failure 	 401    	{object}	responses.Unauthorized
+// @Failure      422		{object}	responses.UnprocessableEntity
+// @Failure      500		{object}	responses.InternalServerError
+// @Router       /api-keys [get]
+func (h *PhoneAPIKeyHandler) Index(c *fiber.Ctx) error {
+	ctx, span, ctxLogger := h.tracer.StartFromFiberCtxWithLogger(c, h.logger)
+	defer span.End()
+
+	var request requests.PhoneAPIKeyIndex
+	if err := c.QueryParser(&request); err != nil {
+		msg := fmt.Sprintf("cannot marshall params [%s] into %T", c.OriginalURL(), request)
+		ctxLogger.Warn(stacktrace.Propagate(err, msg))
+		return h.responseBadRequest(c, err)
+	}
+
+	if errors := h.validator.ValidateIndex(ctx, request.Sanitize()); len(errors) != 0 {
+		msg := fmt.Sprintf("validation errors [%s], while fetching phone API keys [%+#v]", spew.Sdump(errors), request)
+		ctxLogger.Warn(stacktrace.NewError(msg))
+		return h.responseUnprocessableEntity(c, errors, "validation errors while fetching phone API keys")
+	}
+
+	apiKeys, err := h.service.Index(ctx, h.userIDFomContext(c), request.ToIndexParams())
+	if err != nil {
+		msg := fmt.Sprintf("cannot index phone API keys with params [%+#v]", request)
+		ctxLogger.Error(stacktrace.Propagate(err, msg))
+		return h.responseInternalServerError(c)
+	}
+
+	return h.responseOK(c, fmt.Sprintf("fetched %d phone API %s", len(apiKeys), h.pluralize("key", len(apiKeys))), apiKeys)
+}
+
 // Store a new Phone API key
 // @Summary      Store phone API key
 // @Description  Creates a new phone API key which can be used to log in to the httpSMS app on your Android phone
@@ -54,18 +98,16 @@ func (h *PhoneAPIKeyHandler) RegisterRoutes(app *fiber.App, middlewares ...fiber
 // @Accept       json
 // @Produce      json
 // @Param        payload   	body 		requests.PhoneAPIKeyStoreRequest 	true 	"Payload of new phone API key."
-// @Success      200 		{object}	responses.Ok[*entities.PhoneAPIKey]
+// @Success      200 		{object}	responses.PhoneAPIKeyResponse
 // @Failure      400		{object}	responses.BadRequest
 // @Failure 	 401    	{object}	responses.Unauthorized
 // @Failure      422		{object}	responses.UnprocessableEntity
 // @Failure      500		{object}	responses.InternalServerError
 // @Router       /api-keys [post]
 func (h *PhoneAPIKeyHandler) Store(c *fiber.Ctx) error {
-	ctx, span := h.tracer.StartFromFiberCtx(c)
+	ctx, span, ctxLogger := h.tracer.StartFromFiberCtxWithLogger(c, h.logger)
 	defer span.End()
 
-	ctxLogger := h.tracer.CtxLogger(h.logger, span)
-
 	var request requests.PhoneAPIKeyStoreRequest
 	if err := c.BodyParser(&request); err != nil {
 		msg := fmt.Sprintf("cannot marshall params [%s] into %T", c.OriginalURL(), request)

api/docs/swagger.json

@@ -0,0 +1,37 @@
+package requests
+
+import (
+	"strings"
+
+	"github.com/NdoleStudio/httpsms/pkg/repositories"
+)
+
+// PhoneAPIKeyIndex is the payload for fetching entities.PhoneAPIKey of a user
+type PhoneAPIKeyIndex struct {
+	request
+	Skip  string `json:"skip" query:"skip"`
+	Query string `json:"query" query:"query"`
+	Limit string `json:"limit" query:"limit"`
+}
+
+// Sanitize sets defaults to MessageOutstanding
+func (input *PhoneAPIKeyIndex) Sanitize() PhoneAPIKeyIndex {
+	if strings.TrimSpace(input.Limit) == "" {
+		input.Limit = "1"
+	}
+	input.Query = strings.TrimSpace(input.Query)
+	input.Skip = strings.TrimSpace(input.Skip)
+	if input.Skip == "" {
+		input.Skip = "0"
+	}
+	return *input
+}
+
+// ToIndexParams converts HeartbeatIndex to repositories.IndexParams
+func (input *PhoneAPIKeyIndex) ToIndexParams() repositories.IndexParams {
+	return repositories.IndexParams{
+		Skip:  input.getInt(input.Skip),
+		Query: input.Query,
+		Limit: input.getInt(input.Limit),
+	}
+}

api/docs/swagger.yaml

@@ -17,7 +17,7 @@ type PhoneIndex struct {
 // Sanitize sets defaults to MessageOutstanding
 func (input *PhoneIndex) Sanitize() PhoneIndex {
 	if strings.TrimSpace(input.Limit) == "" {
-		input.Limit = "1"
+		input.Limit = "10"
 	}
 	input.Query = strings.TrimSpace(input.Query)
 	input.Skip = strings.TrimSpace(input.Skip)

api/pkg/handlers/phone_api_key_handler.go

@@ -0,0 +1,15 @@
+package responses
+
+import "github.com/NdoleStudio/httpsms/pkg/entities"
+
+// PhoneAPIKeyResponse is the payload containing an entities.PhoneAPIKey
+type PhoneAPIKeyResponse struct {
+	response
+	Data entities.PhoneAPIKey `json:"data"`
+}
+
+// PhoneAPIKeysResponse is the payload containing []entities.PhoneAPIKey
+type PhoneAPIKeysResponse struct {
+	response
+	Data []entities.PhoneAPIKey `json:"data"`
+}

api/pkg/requests/phone_api_key_index_request.go

@@ -38,6 +38,21 @@ func NewPhoneAPIKeyService(
 	}
 }
 
+// Index fetches the entities.Webhook for an entities.UserID
+func (service *PhoneAPIKeyService) Index(ctx context.Context, userID entities.UserID, params repositories.IndexParams) ([]*entities.PhoneAPIKey, error) {
+	ctx, span, ctxLogger := service.tracer.StartWithLogger(ctx, service.logger)
+	defer span.End()
+
+	phoneAPIKeys, err := service.repository.Index(ctx, userID, params)
+	if err != nil {
+		msg := fmt.Sprintf("could not fetch phone API Keys with params [%+#v]", params)
+		return nil, service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
+	}
+
+	ctxLogger.Info(fmt.Sprintf("fetched [%d] phone API Keys with prams [%+#v]", len(phoneAPIKeys), params))
+	return phoneAPIKeys, nil
+}
+
 // Create a new entities.PhoneAPIKey
 func (service *PhoneAPIKeyService) Create(ctx context.Context, authContext entities.AuthContext, name string) (*entities.PhoneAPIKey, error) {
 	ctx, span, ctxLogger := service.tracer.StartWithLogger(ctx, service.logger)

api/pkg/requests/phone_index_request.go

@@ -34,6 +34,7 @@ func (validator *PhoneAPIKeyHandlerValidator) ValidateStore(_ context.Context, r
 		Data: &request,
 		Rules: govalidator.MapData{
 			"name": []string{
+				"required",
 				"min:1",
 				"max:60",
 			},
@@ -42,3 +43,27 @@ func (validator *PhoneAPIKeyHandlerValidator) ValidateStore(_ context.Context, r
 
 	return v.ValidateStruct()
 }
+
+// ValidateIndex validates the requests.HeartbeatIndex request
+func (validator *PhoneAPIKeyHandlerValidator) ValidateIndex(_ context.Context, request requests.PhoneAPIKeyIndex) url.Values {
+	v := govalidator.New(govalidator.Options{
+		Data: &request,
+		Rules: govalidator.MapData{
+			"limit": []string{
+				"required",
+				"numeric",
+				"min:1",
+				"max:100",
+			},
+			"skip": []string{
+				"required",
+				"numeric",
+				"min:0",
+			},
+			"query": []string{
+				"max:100",
+			},
+		},
+	})
+	return v.ValidateStruct()
+}

api/pkg/responses/phone_api_key_responses.go

@@ -163,6 +163,18 @@
               </v-list-item-title>
             </v-list-item-content>
           </v-list-item>
+          <v-list-item :to="{ name: 'phone-api-keys' }" exact>
+            <v-list-item-icon class="pl-2">
+              <v-icon dense>{{ mdiCellphoneKey }}</v-icon>
+            </v-list-item-icon>
+            <v-list-item-content class="ml-n3">
+              <v-list-item-title class="pr-16 py-1">
+                <span :class="{ 'pr-16': $vuetify.breakpoint.mdAndUp }">
+                  Phone API Keys
+                </span>
+              </v-list-item-title>
+            </v-list-item-content>
+          </v-list-item>
           <v-list-item
             v-if="$store.getters.getOwner"
             :href="$store.getters.getAppData.appDownloadUrl"
@@ -221,6 +233,7 @@ import {
   mdiPlus,
   mdiAccountCog,
   mdiLogout,
+  mdiCellphoneKey,
   mdiDownload,
   mdiFinance,
   mdiBatteryChargingHigh,
@@ -241,6 +254,7 @@ export default class MessageThreadHeader extends Vue {
   mdiAccountCog = mdiAccountCog
   mdiLogout = mdiLogout
   mdiDownload = mdiDownload
+  mdiCellphoneKey = mdiCellphoneKey
   mdiPackageUp = mdiPackageUp
   mdiCommentTextMultipleOutline = mdiCommentTextMultipleOutline
   mdiFinance = mdiFinance