Send and receive SMS messages using your Android phone programmatically via a simple HTTP API
Added tests for the phone api key endpoint
Acho Arnold53c867067a5a
diff --git a/README.md b/README.mdindex c30832b3..49c41f9a 100644--- a/README.md+++ b/README.md@@ -6,6 +6,7 @@[](CODE_OF_CONDUCT.md)[](https://scrutinizer-ci.com/g/NdoleStudio/httpsms/?branch=main)[](https://uptime.betterstack.com/?utm_source=status_badge)+[](https://github.com/sponsors/ndolestudio)[](https://discord.gg/kGk8HVqeEZ)[httpSMS](https://httpsms.com) is a service that lets you use your Android phone as an SMS Gateway to send and receive SMS messages.diff --git a/api/docs/docs.go b/api/docs/docs.goindex dcedd506..274f7e6d 100644--- a/api/docs/docs.go+++ b/api/docs/docs.go@@ -45,7 +45,7 @@ const docTemplate = `{{"minimum": 0,"type": "integer",- "description": "number of heartbeats to skip",+ "description": "number of api keys to skip","name": "skip","in": "query"},@@ -59,7 +59,7 @@ const docTemplate = `{"maximum": 100,"minimum": 1,"type": "integer",- "description": "number of phone api keys to return",+ "description": "number of api keys to return","name": "limit","in": "query"}@@ -113,7 +113,7 @@ const docTemplate = `{"tags": ["PhoneAPIKeys"],- "summary": "Store phone API key",+ "summary": "store phone API key","parameters": [{"description": "Payload of new phone API key.",@@ -3224,7 +3224,7 @@ const docTemplate = `{"properties": {"api_key": {"type": "string",- "example": "pk_DGW8NwQp7mxKaSZ72Xq9v67SLqSbWQvckzzmK8D6rvd7NywSEkdMJtuxKyEkYnCY"+ "example": "pk_DGW8NwQp7mxKaSZ72Xq9v6xxxxx"},"created_at": {"type": "string",diff --git a/api/docs/swagger.json b/api/docs/swagger.jsonindex 07f074d2..5130748a 100644--- a/api/docs/swagger.json+++ b/api/docs/swagger.json@@ -33,7 +33,7 @@{"minimum": 0,"type": "integer",- "description": "number of heartbeats to skip",+ "description": "number of api keys to skip","name": "skip","in": "query"},@@ -47,7 +47,7 @@"maximum": 100,"minimum": 1,"type": "integer",- "description": "number of phone api keys to return",+ "description": "number of api keys to return","name": "limit","in": "query"}@@ -95,7 +95,7 @@"consumes": ["application/json"],"produces": ["application/json"],"tags": ["PhoneAPIKeys"],- "summary": "Store phone API key",+ "summary": "store phone API key","parameters": [{"description": "Payload of new phone API key.",@@ -2964,7 +2964,7 @@"properties": {"api_key": {"type": "string",- "example": "pk_DGW8NwQp7mxKaSZ72Xq9v67SLqSbWQvckzzmK8D6rvd7NywSEkdMJtuxKyEkYnCY"+ "example": "pk_DGW8NwQp7mxKaSZ72Xq9v6xxxxx"},"created_at": {"type": "string",diff --git a/api/docs/swagger.yaml b/api/docs/swagger.yamlindex f9ddbfc7..5cc0f418 100644--- a/api/docs/swagger.yaml+++ b/api/docs/swagger.yaml@@ -328,7 +328,7 @@ definitions:entities.PhoneAPIKey:properties:api_key:- example: pk_DGW8NwQp7mxKaSZ72Xq9v67SLqSbWQvckzzmK8D6rvd7NywSEkdMJtuxKyEkYnCY+ example: pk_DGW8NwQp7mxKaSZ72Xq9v6xxxxxtype: stringcreated_at:example: "2022-06-05T14:26:02.302718+03:00"@@ -1203,7 +1203,7 @@ paths:Get list phone API keys which a user has registered on the httpSMSapplicationparameters:- - description: number of heartbeats to skip+ - description: number of api keys to skipin: queryminimum: 0name: skip@@ -1212,7 +1212,7 @@ paths:in: queryname: querytype: string- - description: number of phone api keys to return+ - description: number of api keys to returnin: querymaximum: 100minimum: 1@@ -1284,7 +1284,7 @@ paths:$ref: "#/definitions/responses.InternalServerError"security:- ApiKeyAuth: []- summary: Store phone API key+ summary: store phone API keytags:- PhoneAPIKeys/api-keys/{phoneAPIKeyID}:diff --git a/api/go.mod b/api/go.modindex 47b7497d..70577da9 100644--- a/api/go.mod+++ b/api/go.mod@@ -25,6 +25,7 @@ require (github.com/google/uuid v1.6.0github.com/hashicorp/go-retryablehttp v0.7.7github.com/hirosassa/zerodriver v0.1.4+ github.com/jaswdr/faker/v2 v2.3.3github.com/jinzhu/now v1.1.5github.com/joho/godotenv v1.5.1github.com/jordan-wright/email v4.0.1-0.20210109023952-943e75fe5223+incompatiblediff --git a/api/go.sum b/api/go.sumindex faecefdb..9169fb90 100644--- a/api/go.sum+++ b/api/go.sum@@ -176,6 +176,8 @@ github.com/jackc/pgx/v5 v5.7.2 h1:mLoDLV6sonKlvjIEsV56SkWNCnuNv531l94GaIzO+XI=github.com/jackc/pgx/v5 v5.7.2/go.mod h1:ncY89UGWxg82EykZUwSpUKEfccBGGYq1xjrOpsbsfGQ=github.com/jackc/puddle/v2 v2.2.2 h1:PR8nw+E/1w0GLuRFSmiioY6UooMp6KJv0/61nB7icHo=github.com/jackc/puddle/v2 v2.2.2/go.mod h1:vriiEXHvEE654aYKXXjOvZM39qJ0q+azkZFrfEOc3H4=+github.com/jaswdr/faker/v2 v2.3.3 h1:0mA+B5YGjqgpOPdDY/72d6pDv7Z/5t6F1XzIfkUfgC4=+github.com/jaswdr/faker/v2 v2.3.3/go.mod h1:ROK8xwQV0hYOLDUtxCQgHGcl10jbVzIvqHxcIDdwY2Q=github.com/jaytaylor/html2text v0.0.0-20180606194806-57d518f124b0/go.mod h1:CVKlgaMiht+LXvHG173ujK6JUhZXKb2u/BQtjPDIvyk=github.com/jaytaylor/html2text v0.0.0-20230321000545-74c2419ad056 h1:iCHtR9CQyktQ5+f3dMVZfwD2KWJUgm7M0gdL9NGr8KA=github.com/jaytaylor/html2text v0.0.0-20230321000545-74c2419ad056/go.mod h1:CVKlgaMiht+LXvHG173ujK6JUhZXKb2u/BQtjPDIvyk=diff --git a/api/pkg/di/container.go b/api/pkg/di/container.goindex bd8d089e..cd21e074 100644--- a/api/pkg/di/container.go+++ b/api/pkg/di/container.go@@ -699,6 +699,7 @@ func (container *Container) PhoneAPIKeyRepository() (repository repositories.Phocontainer.Logger(),container.Tracer(),container.DB(),+ container.UserRistrettoCache(),)}diff --git a/api/pkg/entities/phone_api_key.go b/api/pkg/entities/phone_api_key.goindex 89a2a6c9..949dea52 100644--- a/api/pkg/entities/phone_api_key.go+++ b/api/pkg/entities/phone_api_key.go@@ -15,7 +15,7 @@ type PhoneAPIKey struct {UserEmail string `json:"user_email" example:"[email protected]"`PhoneNumbers pq.StringArray `json:"phone_numbers" example:"[+18005550199,+18005550100]" gorm:"type:text[]" swaggertype:"array,string"`PhoneIDs pq.StringArray `json:"phone_ids" example:"[32343a19-da5e-4b1b-a767-3298a73703cb,32343a19-da5e-4b1b-a767-3298a73703cc]" gorm:"type:text[]" swaggertype:"array,string"`- APIKey string `json:"api_key" example:"pk_DGW8NwQp7mxKaSZ72Xq9v67SLqSbWQvckzzmK8D6rvd7NywSEkdMJtuxKyEkYnCY"`+ APIKey string `json:"api_key" gorm:"uniqueIndex:idx_phone_api_key__api_key" example:"pk_DGW8NwQp7mxKaSZ72Xq9v6xxxxx"`CreatedAt time.Time `json:"created_at" example:"2022-06-05T14:26:02.302718+03:00"`UpdatedAt time.Time `json:"updated_at" example:"2022-06-05T14:26:02.302718+03:00"`}diff --git a/api/pkg/handlers/handler_test.go b/api/pkg/handlers/handler_test.gonew file mode 100644index 00000000..a8aab4c6--- /dev/null+++ b/api/pkg/handlers/handler_test.go@@ -0,0 +1,13 @@+package handlers++import (+ "os"++ "github.com/carlmjohnson/requests"+ _ "github.com/joho/godotenv/autoload" // import USER_API_KEY from .env file+)++func testClient() *requests.Builder {+ return requests.URL("http://localhost:8000").+ Header("x-api-key", os.Getenv("USER_API_KEY"))+}diff --git a/api/pkg/handlers/phone_api_key_handler.go b/api/pkg/handlers/phone_api_key_handler.goindex 01692148..17b3ed6a 100644--- a/api/pkg/handlers/phone_api_key_handler.go+++ b/api/pkg/handlers/phone_api_key_handler.go@@ -40,30 +40,29 @@ func NewPhoneAPIKeyHandler(// RegisterRoutes registers the routes for the PhoneAPIKeyHandlerfunc (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)...)+ 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)...)}-// 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)+// @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 {+func (h *PhoneAPIKeyHandler) index(c *fiber.Ctx) error {ctx, span, ctxLogger := h.tracer.StartFromFiberCtxWithLogger(c, h.logger)defer span.End()@@ -90,7 +89,6 @@ func (h *PhoneAPIKeyHandler) Index(c *fiber.Ctx) error {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// @Security ApiKeyAuth@@ -104,7 +102,7 @@ func (h *PhoneAPIKeyHandler) Index(c *fiber.Ctx) error {// @Failure 422 {object} responses.UnprocessableEntity// @Failure 500 {object} responses.InternalServerError// @Router /api-keys [post]-func (h *PhoneAPIKeyHandler) Store(c *fiber.Ctx) error {+func (h *PhoneAPIKeyHandler) store(c *fiber.Ctx) error {ctx, span, ctxLogger := h.tracer.StartFromFiberCtxWithLogger(c, h.logger)defer span.End()@@ -121,24 +119,23 @@ func (h *PhoneAPIKeyHandler) Store(c *fiber.Ctx) error {return h.responseUnprocessableEntity(c, errors, "validation errors while updating phones")}- phone, err := h.service.Create(ctx, h.userFromContext(c), request.Name)+ 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 updated successfully", phone)+ return h.responseOK(c, "phone API key created successfully", phoneAPIKey)}-// Delete a phone API Key// @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)+// @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@@ -146,7 +143,7 @@ func (h *PhoneAPIKeyHandler) Store(c *fiber.Ctx) error {// @Failure 422 {object} responses.UnprocessableEntity// @Failure 500 {object} responses.InternalServerError// @Router /api-keys/{phoneAPIKeyID} [delete]-func (h *PhoneAPIKeyHandler) Delete(c *fiber.Ctx) error {+func (h *PhoneAPIKeyHandler) delete(c *fiber.Ctx) error {ctx, span, ctxLogger := h.tracer.StartFromFiberCtxWithLogger(c, h.logger)defer span.End()@@ -171,7 +168,6 @@ func (h *PhoneAPIKeyHandler) Delete(c *fiber.Ctx) error {return h.responseNoContent(c, "phone API key deleted successfully")}-// DeletePhone removes a phone from a phone API key// @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@@ -187,7 +183,7 @@ func (h *PhoneAPIKeyHandler) Delete(c *fiber.Ctx) error {// @Failure 422 {object} responses.UnprocessableEntity// @Failure 500 {object} responses.InternalServerError// @Router /api-keys/{phoneAPIKeyID}/phones/{phoneID} [delete]-func (h *PhoneAPIKeyHandler) DeletePhone(c *fiber.Ctx) error {+func (h *PhoneAPIKeyHandler) deletePhone(c *fiber.Ctx) error {ctx, span, ctxLogger := h.tracer.StartFromFiberCtxWithLogger(c, h.logger)defer span.End()diff --git a/api/pkg/handlers/phone_api_key_handler_test.go b/api/pkg/handlers/phone_api_key_handler_test.gonew file mode 100644index 00000000..a2bc0a4b--- /dev/null+++ b/api/pkg/handlers/phone_api_key_handler_test.go@@ -0,0 +1,116 @@+package handlers++import (+ "context"+ "slices"+ "strings"+ "testing"++ "github.com/NdoleStudio/httpsms/pkg/entities"+ "github.com/NdoleStudio/httpsms/pkg/requests"+ "github.com/NdoleStudio/httpsms/pkg/responses"+ "github.com/jaswdr/faker/v2"+ "github.com/stretchr/testify/assert"+)++func TestPhoneAPIKeyHandler_store(t *testing.T) {+ // Arrange+ fake := faker.New()+ payload := requests.PhoneAPIKeyStoreRequest{+ Name: fake.RandomStringWithLength(20),+ }+ response := new(responses.PhoneAPIKeyResponse)++ // Act+ err := testClient().+ Post().+ Path("/v1/phone-api-keys").+ BodyJSON(payload).+ ToJSON(response).+ Fetch(context.Background())++ // Assert+ assert.Nil(t, err)+ assert.NotEmpty(t, response.Data.ID)+ assert.True(t, strings.HasPrefix(response.Data.APIKey, "pk_"))+ assert.Equal(t, payload.Name, response.Data.Name)+ assert.True(t, len(response.Data.PhoneNumbers) == 0)+ assert.True(t, len(response.Data.PhoneIDs) == 0)++ // Teardown+ _ = testClient().+ Delete().+ Path("/v1/phone-api-keys/" + response.Data.ID.String()).+ Fetch(context.Background())+}++func TestPhoneAPIKeyHandler_delete(t *testing.T) {+ // Arrange+ fake := faker.New()+ payload := requests.PhoneAPIKeyStoreRequest{+ Name: fake.RandomStringWithLength(20),+ }++ // Act+ response := new(responses.PhoneAPIKeyResponse)+ _ = testClient().+ Post().+ Path("/v1/phone-api-keys").+ BodyJSON(payload).+ ToJSON(response).+ Fetch(context.Background())++ err := testClient().+ Delete().+ Path("/v1/phone-api-keys/" + response.Data.ID.String()).+ Fetch(context.Background())++ // Assert+ assert.Nil(t, err)++ keys := new(responses.PhoneAPIKeysResponse)+ _ = testClient().+ Path("/v1/phone-api-keys").+ ToJSON(response).+ Fetch(context.Background())++ assert.Equal(t, -1, slices.IndexFunc(keys.Data, func(key *entities.PhoneAPIKey) bool {+ return key.ID == response.Data.ID+ }))+}++func TestPhoneAPIKeyHandler_index(t *testing.T) {+ // Arrange+ fake := faker.New()+ createResponse := new(responses.PhoneAPIKeyResponse)+ response := new(responses.PhoneAPIKeysResponse)+ payload := requests.PhoneAPIKeyStoreRequest{+ Name: fake.RandomStringWithLength(20),+ }++ // Act+ _ = testClient().+ Post().+ Path("/v1/phone-api-keys").+ BodyJSON(payload).+ ToJSON(createResponse).+ Fetch(context.Background())++ err := testClient().+ Path("/v1/phone-api-keys").+ ToJSON(response).+ Fetch(context.Background())++ // Assert+ assert.Nil(t, err)+ assert.NotEmpty(t, response.Data)+ assert.NotEqual(t, -1, slices.IndexFunc(response.Data, func(key *entities.PhoneAPIKey) bool {+ return key.ID == createResponse.Data.ID+ }))++ // Teardown+ _ = testClient().+ Delete().+ Path("/v1/phone-api-keys/" + createResponse.Data.ID.String()).+ Fetch(context.Background())+}diff --git a/api/pkg/responses/phone_api_key_responses.go b/api/pkg/responses/phone_api_key_responses.goindex f57eeafa..fff077c2 100644--- a/api/pkg/responses/phone_api_key_responses.go+++ b/api/pkg/responses/phone_api_key_responses.go@@ -5,11 +5,11 @@ import "github.com/NdoleStudio/httpsms/pkg/entities"// PhoneAPIKeyResponse is the payload containing an entities.PhoneAPIKeytype PhoneAPIKeyResponse struct {response- Data entities.PhoneAPIKey `json:"data"`+ Data *entities.PhoneAPIKey `json:"data"`}// PhoneAPIKeysResponse is the payload containing []entities.PhoneAPIKeytype PhoneAPIKeysResponse struct {response- Data []entities.PhoneAPIKey `json:"data"`+ Data []*entities.PhoneAPIKey `json:"data"`}diff --git a/api/pkg/services/phone_api_key_service.go b/api/pkg/services/phone_api_key_service.goindex f718bd12..9b46cfe4 100644--- a/api/pkg/services/phone_api_key_service.go+++ b/api/pkg/services/phone_api_key_service.go@@ -7,6 +7,8 @@ import ("fmt""time"+ "github.com/lib/pq"+"github.com/NdoleStudio/httpsms/pkg/entities""github.com/NdoleStudio/httpsms/pkg/repositories""github.com/NdoleStudio/httpsms/pkg/telemetry"@@ -68,8 +70,8 @@ func (service *PhoneAPIKeyService) Create(ctx context.Context, authContext entitName: name,UserID: authContext.ID,UserEmail: authContext.Email,- PhoneNumbers: nil,- PhoneIDs: nil,+ PhoneNumbers: pq.StringArray{},+ PhoneIDs: pq.StringArray{},APIKey: "pk_" + apiKey,CreatedAt: time.Now().UTC(),UpdatedAt: time.Now().UTC(),diff --git a/web/pages/phone-api-keys/index.vue b/web/pages/phone-api-keys/index.vueindex cfc1d9ff..49771a9e 100644--- a/web/pages/phone-api-keys/index.vue+++ b/web/pages/phone-api-keys/index.vue@@ -354,7 +354,9 @@ export default Vue.extend({})this.webhookChannel = pusher.subscribe(this.$store.getters.getAuthUser.id)this.webhookChannel.bind('phone.updated', () => {- this.loadPhoneApiKeys()+ if (!this.loading) {+ this.loadPhoneApiKeys()+ }})},beforeDestroy() {@@ -384,7 +386,6 @@ export default Vue.extend({},generateQrCode(text: string) {const canvas = this.$refs.qrCodeCanvas- console.log(canvas)if (canvas) {QRCode.toCanvas(canvas,diff --git a/web/store/index.ts b/web/store/index.tsindex 71a1314f..30f83ae8 100644--- a/web/store/index.ts+++ b/web/store/index.ts@@ -438,7 +438,7 @@ export const actions = {storePhoneApiKey(context: ActionContext<State, State>, name: string) {return new Promise<ResponsesPhoneAPIKeyResponse>((resolve, reject) => {axios- .post<ResponsesPhoneAPIKeyResponse>(`/v1/api-keys`, { name })+ .post<ResponsesPhoneAPIKeyResponse>(`/v1/phone-api-keys`, { name }).then(async (response: AxiosResponse<ResponsesPhoneAPIKeyResponse>) => {await context.dispatch('addNotification', {message:@@ -464,7 +464,7 @@ export const actions = {indexPhoneApiKeys(context: ActionContext<State, State>) {return new Promise<Array<EntitiesPhoneAPIKey>>((resolve, reject) => {axios- .get<ResponsesPhoneAPIKeysResponse>(`/v1/api-keys`, {+ .get<ResponsesPhoneAPIKeysResponse>(`/v1/phone-api-keys`, {params: {limit: 100,},@@ -492,7 +492,7 @@ export const actions = {) {return new Promise<void>((resolve, reject) => {axios- .delete<ResponsesNoContent>(`/v1/api-keys/${phoneAPIKeyID}`)+ .delete<ResponsesNoContent>(`/v1/phone-api-keys/${phoneAPIKeyID}`).then(async (response: AxiosResponse<ResponsesNoContent>) => {await context.dispatch('addNotification', {message:@@ -523,7 +523,7 @@ export const actions = {return new Promise<void>((resolve, reject) => {axios.delete<ResponsesNoContent>(- `/v1/api-keys/${payload.phoneApiKeyId}/phones/${payload.phoneId}`,+ `/v1/phone-api-keys/${payload.phoneApiKeyId}/phones/${payload.phoneId}`,).then(async (response: AxiosResponse<ResponsesNoContent>) => {await context.dispatch('addNotification', {