NdoleStudio / httpsms

import (

	"fmt"

	"github.com/NdoleStudio/httpsms/pkg/repositories"

	"github.com/NdoleStudio/httpsms/pkg/requests"

	"github.com/NdoleStudio/httpsms/pkg/services"

	"github.com/NdoleStudio/httpsms/pkg/telemetry"

	"github.com/NdoleStudio/httpsms/pkg/validators"

	"github.com/davecgh/go-spew/spew"

	"github.com/gofiber/fiber/v2"

	"github.com/google/uuid"

	"github.com/palantir/stacktrace"

)

// PhoneAPIKeyHandler handles phone API key http requests

type PhoneAPIKeyHandler struct {

	handler

	logger    telemetry.Logger

	tracer    telemetry.Tracer

	validator *validators.PhoneAPIKeyHandlerValidator

	service   *services.PhoneAPIKeyService

}

// NewPhoneAPIKeyHandler creates a new PhoneAPIKeyHandler

func NewPhoneAPIKeyHandler(

	logger telemetry.Logger,

	tracer telemetry.Tracer,

	validator *validators.PhoneAPIKeyHandlerValidator,

	service *services.PhoneAPIKeyService,

) *PhoneAPIKeyHandler {

	return &PhoneAPIKeyHandler{

		logger:    logger.WithService(fmt.Sprintf("%T", &PhoneAPIKeyHandler{})),

		tracer:    tracer,

		validator: validator,

		service:   service,

	}

}

// RegisterRoutes registers the routes for the PhoneAPIKeyHandler

func (h *PhoneAPIKeyHandler) RegisterRoutes(app *fiber.App, middlewares ...fiber.Handler) {

	router := app.Group("/v1/phone-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)...)

}

// @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 phone api keys to skip"					minimum(0)

// @Param        query		query  string  	false 	"filter phone 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)

}

// @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

// @Security	 ApiKeyAuth

// @Tags         PhoneAPIKeys

// @Accept       json

// @Produce      json

// @Param        payload   	body 		requests.PhoneAPIKeyStoreRequest 	true 	"Payload of new phone API key."

// @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, ctxLogger := h.tracer.StartFromFiberCtxWithLogger(c, h.logger)

	defer span.End()

	var request requests.PhoneAPIKeyStoreRequest

	if err := c.BodyParser(&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.ValidateStore(ctx, request.Sanitize()); len(errors) != 0 {

		msg := fmt.Sprintf("validation errors [%s], while updating phones [%+#v]", spew.Sdump(errors), request)

		ctxLogger.Warn(stacktrace.NewError(msg))

		return h.responseUnprocessableEntity(c, errors, "validation errors while updating phones")

	}

	phoneAPIKey, err := h.service.Create(ctx, h.userFromContext(c), request.Name)

	if err != nil {

		msg := fmt.Sprintf("cannot update phones with params [%+#v]", request)

		ctxLogger.Error(stacktrace.Propagate(err, msg))

		return h.responseInternalServerError(c)

	}

	return h.responseOK(c, "phone API key created successfully", phoneAPIKey)

}

// @Summary      Delete a phone API key from the database.

// @Description  Delete a phone API Key from the database and cannot be used for authentication anymore.

// @Security	 ApiKeyAuth

// @Tags         PhoneAPIKeys

// @Accept       json

// @Produce      json

// @Param 		 phoneAPIKeyID 	path	string 							true 	"ID of the phone API key" 	default(32343a19-da5e-4b1b-a767-3298a73703ca)

// @Success      204  		{object} 	responses.NoContent

// @Failure      400  		{object}  	responses.BadRequest

// @Failure 	 401    	{object}	responses.Unauthorized

// @Failure 	 404		{object}	responses.NotFound

// @Failure      422  		{object} 	responses.UnprocessableEntity

// @Failure      500  		{object}  	responses.InternalServerError

// @Router       /api-keys/{phoneAPIKeyID} [delete]

func (h *PhoneAPIKeyHandler) delete(c *fiber.Ctx) error {

	ctx, span, ctxLogger := h.tracer.StartFromFiberCtxWithLogger(c, h.logger)

	defer span.End()

	phoneAPIKeyID := c.Params("phoneAPIKeyID")

	if errors := h.validator.ValidateUUID(phoneAPIKeyID, "phoneAPIKeyID"); len(errors) != 0 {

		msg := fmt.Sprintf("validation errors [%s], while deleting a phone API key with ID [%s]", spew.Sdump(errors), phoneAPIKeyID)

		ctxLogger.Warn(stacktrace.NewError(msg))

		return h.responseUnprocessableEntity(c, errors, "validation errors while storing event")

	}

	err := h.service.Delete(ctx, h.userIDFomContext(c), uuid.MustParse(phoneAPIKeyID))

	if stacktrace.GetCode(err) == repositories.ErrCodeNotFound {

		return h.responseNotFound(c, fmt.Sprintf("cannot find phone API key with ID [%s]", phoneAPIKeyID))

	}

	if err != nil {

		msg := fmt.Sprintf("cannot delete phone API key with ID [%s] for user with ID [%s]", phoneAPIKeyID, h.userIDFomContext(c))

		ctxLogger.Error(h.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg)))

		return h.responseInternalServerError(c)

	}

	return h.responseNoContent(c, "phone API key deleted successfully")

}

// @Summary      Remove the association of a phone from the phone API key.

// @Description  You will need to login again to the httpSMS app on your Android phone with a new phone API key.

// @Security	 ApiKeyAuth

// @Tags         PhoneAPIKeys

// @Accept       json

// @Produce      json

// @Param 		 phoneAPIKeyID 	path		string 							true 	"ID of the phone API key" 	default(32343a19-da5e-4b1b-a767-3298a73703ca)

// @Param 		 phoneID 		path		string 							true 	"ID of the phone" 			default(32343a19-da5e-4b1b-a767-3298a73703ca)

// @Success      204  			{object} 	responses.NoContent

// @Failure      400  			{object}  	responses.BadRequest

// @Failure 	 401    		{object}	responses.Unauthorized

// @Failure 	 404			{object}	responses.NotFound

// @Failure      422  			{object} 	responses.UnprocessableEntity

// @Failure      500  			{object}  	responses.InternalServerError

// @Router       /api-keys/{phoneAPIKeyID}/phones/{phoneID} [delete]