Merge pull request #34 from capcom6/feature/skip-phone-validation

[3rdparty][messages] skip phone validation option

api/local.http

@@ -3,7 +3,7 @@
 @phone={{$dotenv PHONE}}
 
 ###
-POST {{localUrl}}/message HTTP/1.1
+POST {{localUrl}}/message?skipPhoneValidation=true HTTP/1.1
 Content-Type: application/json
 Authorization: Basic {{localCredentials}}
 

api/requests.http

@@ -13,7 +13,7 @@ Content-Type: application/json
 }
 
 ###
-POST {{baseUrl}}/api/3rdparty/v1/message HTTP/1.1
+POST {{baseUrl}}/api/3rdparty/v1/message?skipPhoneValidation=false HTTP/1.1
 Content-Type: application/json
 Authorization: Basic {{credentials}}
 

api/swagger.json

@@ -86,6 +86,12 @@
                 ],
                 "summary": "Поставить сообщение в очередь",
                 "parameters": [
+                    {
+                        "type": "boolean",
+                        "description": "Пропустить проверку номеров телефона",
+                        "name": "skipPhoneValidation",
+                        "in": "query"
+                    },
                     {
                         "description": "Сообщение",
                         "name": "request",

api/swagger.yaml

@@ -219,6 +219,10 @@ paths:
       description: Ставит сообщение в очередь на отправку. Если идентификатор не указан,
         то он будет сгенерирован автоматически
       parameters:
+      - description: Пропустить проверку номеров телефона
+        in: query
+        name: skipPhoneValidation
+        type: boolean
       - description: Сообщение
         in: body
         name: request

internal/sms-gateway/handlers/3rdparty.go

@@ -30,12 +30,13 @@ type thirdPartyHandler struct {
 //	@Tags			Пользователь, Сообщения
 //	@Accept			json
 //	@Produce		json
-//	@Param			request	body		smsgateway.Message			true	"Сообщение"
-//	@Success		202		{object}	smsgateway.MessageState		"Сообщение поставлено в очередь"
-//	@Failure		401		{object}	smsgateway.ErrorResponse	"Ошибка авторизации"
-//	@Failure		400		{object}	smsgateway.ErrorResponse	"Некорректный запрос"
-//	@Failure		500		{object}	smsgateway.ErrorResponse	"Внутренняя ошибка сервера"
-//	@Header			202		{string}	Location					"URL для получения состояния сообщения"
+//	@Param			skipPhoneValidation	query		bool						false	"Пропустить проверку номеров телефона"
+//	@Param			request				body		smsgateway.Message			true	"Сообщение"
+//	@Success		202					{object}	smsgateway.MessageState		"Сообщение поставлено в очередь"
+//	@Failure		401					{object}	smsgateway.ErrorResponse	"Ошибка авторизации"
+//	@Failure		400					{object}	smsgateway.ErrorResponse	"Некорректный запрос"
+//	@Failure		500					{object}	smsgateway.ErrorResponse	"Внутренняя ошибка сервера"
+//	@Header			202					{string}	Location					"URL для получения состояния сообщения"
 //	@Router			/3rdparty/v1/message [post]
 //
 // Поставить сообщение в очередь
@@ -45,12 +46,14 @@ func (h *thirdPartyHandler) postMessage(user models.User, c *fiber.Ctx) error {
 		return fiber.NewError(fiber.StatusBadRequest, err.Error())
 	}
 
+	skipPhoneValidation := c.QueryBool("skipPhoneValidation", false)
+
 	if len(user.Devices) < 1 {
 		return fiber.NewError(fiber.StatusBadRequest, "Нет ни одного устройства в учетной записи")
 	}
 
 	device := user.Devices[0]
-	state, err := h.messagesSvc.Enqeue(device, req)
+	state, err := h.messagesSvc.Enqeue(device, req, services.MessagesEnqueueOptions{SkipPhoneValidation: skipPhoneValidation})
 	if err != nil {
 		var err400 services.ErrValidation
 		if errors.As(err, &err400) {

internal/sms-gateway/repositories/messages.go

@@ -50,7 +50,7 @@ func (r *MessagesRepository) Get(ID string, filter MessagesSelectFilter, options
 }
 
 func (r *MessagesRepository) Insert(message *models.Message) error {
-	return r.db.Create(message).Error
+	return r.db.Omit("Device").Create(message).Error
 }
 
 func (r *MessagesRepository) UpdateState(message *models.Message) error {

internal/sms-gateway/services/messages.go

@@ -27,6 +27,10 @@ func (e ErrValidation) Error() string {
 	return string(e)
 }
 
+type MessagesEnqueueOptions struct {
+	SkipPhoneValidation bool
+}
+
 type MessagesServiceParams struct {
 	fx.In
 
@@ -119,7 +123,7 @@ func (s *MessagesService) GetState(user models.User, ID string) (smsgateway.Mess
 	return modelToMessageState(message), nil
 }
 
-func (s *MessagesService) Enqeue(device models.Device, message smsgateway.Message) (smsgateway.MessageState, error) {
+func (s *MessagesService) Enqeue(device models.Device, message smsgateway.Message, opts MessagesEnqueueOptions) (smsgateway.MessageState, error) {
 	state := smsgateway.MessageState{
 		ID:         "",
 		State:      smsgateway.MessageStatePending,
@@ -129,7 +133,7 @@ func (s *MessagesService) Enqeue(device models.Device, message smsgateway.Messag
 	var phone string
 	var err error
 	for i, v := range message.PhoneNumbers {
-		if message.IsEncrypted {
+		if message.IsEncrypted || opts.SkipPhoneValidation {
 			phone = v
 		} else {
 			if phone, err = cleanPhoneNumber(v); err != nil {

internal/sms-gateway/services/messages_test.go

@@ -105,3 +105,55 @@ func TestMessagesService_recipientsStateToModel(t *testing.T) {
 		})
 	}
 }
+
+func TestCleanPhoneNumber(t *testing.T) {
+	tests := []struct {
+		name        string
+		input       string
+		expected    string
+		expectError bool
+	}{
+		{
+			name:        "Valid number with validation",
+			input:       "+79161234567",
+			expected:    "+79161234567",
+			expectError: false,
+		},
+		{
+			name:        "Invalid number with validation",
+			input:       "+123!@#",
+			expected:    "",
+			expectError: true,
+		},
+		{
+			name:        "Empty input with validation",
+			input:       "",
+			expected:    "",
+			expectError: true,
+		},
+		{
+			name:        "Long number with validation",
+			input:       "+345906566798696",
+			expected:    "",
+			expectError: true,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			result, err := cleanPhoneNumber(tt.input)
+			if tt.expectError {
+				if err == nil {
+					t.Errorf("Expected error, got nil")
+				}
+			} else {
+				if err != nil {
+					t.Errorf("Unexpected error: %v", err)
+				}
+				if result != tt.expected {
+					t.Errorf("Expected %s, got %s", tt.expected, result)
+				}
+			}
+		})
+	}
+}

web/mkdocs/docs/faq.md

@@ -48,3 +48,7 @@ As of version [1.3.0](https://github.com/capcom6/android-sms-gateway/releases/ta
 ## How can I set up delays between sending messages?
 
 To avoid mobile operator restrictions, we introduced a delay feature in version [1.6.0](https://github.com/capcom6/android-sms-gateway/releases/tag/v1.6.0) of our application. You can set a random delay between messages by specifying a maximum delay time. The application will then randomly select a delay within this range for each message sent. This helps to reduce the likelihood of messages being flagged as spam by simulating a more human-like sending pattern.
+
+## Can I use long or non-standard phone numbers?
+
+Yes, starting from [1.6.1](https://github.com/capcom6/android-sms-gateway/releases/tag/v1.6.1) of the app, our system allows the use of long or non-standard phone numbers, which may be common with M2M (machine-to-machine) SIM cards or other special cases. To bypass the standard phone number validation, simply add the query parameter `skipPhoneValidation=true` to your API request. Please note that with validation disabled, you are responsible for ensuring the correctness of the phone numbers. They should still follow the E.164 format, beginning with a '+' and containing only digits.