Skip to content

[client] add ListMessagesOptions validation #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
capcom6 wants to merge 1 commit into
base: master
Choose a base branch
from
+302 −31
Open

[client] add ListMessagesOptions validation #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 17 additions & 7 deletions smsgateway/requests_3rdparty.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package smsgateway

import (
"fmt"
"net/url"
"strconv"
"time"
Expand Down Expand Up @@ -86,13 +87,22 @@ func (o ListInboxOptions) ToURLValues() url.Values {

// ListMessagesOptions holds optional filters for listing messages.
type ListMessagesOptions struct {
From *time.Time
To *time.Time
State *string
DeviceID *string
Limit *int
Offset *int
IncludeContent *bool
From *time.Time `query:"from" validate:"omitempty"`
To *time.Time `query:"to" validate:"omitempty"`
State *string `query:"state" validate:"omitempty,oneof=Pending Cancelling Cancelled Processed Sent Delivered Failed"`
DeviceID *string `query:"deviceId" validate:"omitempty,len=21"`
Limit *int `query:"limit" validate:"omitempty,min=1,max=100"`
Offset *int `query:"offset" validate:"omitempty,min=0"`
IncludeContent *bool `query:"includeContent"`
}

// Validate checks if the ListMessagesOptions are valid.
func (o ListMessagesOptions) Validate() error {
if o.From != nil && o.To != nil && o.From.After(*o.To) {
return fmt.Errorf("%w: `from` date must be before `to` date", ErrValidationFailed)
}

return nil
}

// ToURLValues returns the ListMessagesOptions as URL query parameters.
Expand Down
309 changes: 285 additions & 24 deletions smsgateway/requests_3rdparty_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
package smsgateway_test

import (
"errors"
"net/url"
"reflect"
"testing"
"time"

"github.com/android-sms-gateway/client-go/smsgateway"
)
Expand Down Expand Up @@ -84,63 +86,322 @@ func TestSendOptions_ToURLValues(t *testing.T) {
}
}

func TestSendOptionFunctions(t *testing.T) {
func TestListInboxOptions_ToURLValues(t *testing.T) {
from := time.Date(2024, 1, 1, 0, 0, 0, 0, time.UTC)
to := time.Date(2024, 12, 31, 23, 59, 59, 0, time.UTC)
deviceID := "abc123def456ghi789j"

tests := []struct {
name string
options []smsgateway.SendOption
options smsgateway.ListInboxOptions
expected url.Values
}{
{
name: "No options",
options: []smsgateway.SendOption{},
options: smsgateway.ListInboxOptions{},
expected: url.Values{},
},
{
name: "WithSkipPhoneValidation=true",
options: []smsgateway.SendOption{
smsgateway.WithSkipPhoneValidation(true),
name: "Type set",
options: smsgateway.ListInboxOptions{
Type: ptr(smsgateway.IncomingMessageTypeSMS),
},
expected: url.Values{
"skipPhoneValidation": []string{"true"},
"type": {"SMS"},
},
},
{
name: "WithSkipPhoneValidation=false",
options: []smsgateway.SendOption{
smsgateway.WithSkipPhoneValidation(false),
name: "Limit set",
options: smsgateway.ListInboxOptions{
Limit: ptr(10),
},
expected: url.Values{
"skipPhoneValidation": []string{"false"},
"limit": {"10"},
},
},
{
name: "WithDeviceActiveWithin",
options: []smsgateway.SendOption{
smsgateway.WithDeviceActiveWithin(24),
name: "Offset set",
options: smsgateway.ListInboxOptions{
Offset: ptr(20),
},
expected: url.Values{
"deviceActiveWithin": []string{"24"},
"offset": {"20"},
},
},
{
name: "Multiple options",
options: []smsgateway.SendOption{
smsgateway.WithSkipPhoneValidation(true),
smsgateway.WithDeviceActiveWithin(48),
name: "From set",
options: smsgateway.ListInboxOptions{
From: &from,
},
expected: url.Values{
"skipPhoneValidation": []string{"true"},
"deviceActiveWithin": []string{"48"},
"from": {from.Format(time.RFC3339)},
},
},
{
name: "To set",
options: smsgateway.ListInboxOptions{
To: &to,
},
expected: url.Values{
"to": {to.Format(time.RFC3339)},
},
},
{
name: "DeviceID set",
options: smsgateway.ListInboxOptions{
DeviceID: &deviceID,
},
expected: url.Values{
"deviceId": {deviceID},
},
},
{
name: "All fields set",
options: smsgateway.ListInboxOptions{
Type: ptr(smsgateway.IncomingMessageTypeSMS),
Limit: ptr(50),
Offset: ptr(10),
From: &from,
To: &to,
DeviceID: &deviceID,
},
expected: url.Values{
"type": {"SMS"},
"limit": {"50"},
"offset": {"10"},
"from": {from.Format(time.RFC3339)},
"to": {to.Format(time.RFC3339)},
"deviceId": {deviceID},
},
},
{
name: "Limit zero",
options: smsgateway.ListInboxOptions{
Limit: ptr(0),
},
expected: url.Values{
"limit": {"0"},
},
},
{
name: "Offset zero",
options: smsgateway.ListInboxOptions{
Offset: ptr(0),
},
expected: url.Values{
"offset": {"0"},
},
},
{
name: "DATA_SMS type",
options: smsgateway.ListInboxOptions{
Type: ptr(smsgateway.IncomingMessageTypeDataSMS),
},
expected: url.Values{
"type": {"DATA_SMS"},
},
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
options := &smsgateway.SendOptions{}
options.Apply(tt.options...)
result := tt.options.ToURLValues()

result := options.ToURLValues()
if !reflect.DeepEqual(result, tt.expected) {
t.Errorf("ToURLValues() = %v, expected %v", result, tt.expected)
}
})
}
}

func TestListMessagesOptions_Validate(t *testing.T) {
from := time.Date(2024, 1, 1, 0, 0, 0, 0, time.UTC)
to := time.Date(2024, 12, 31, 23, 59, 59, 0, time.UTC)

tests := []struct {
name string
options smsgateway.ListMessagesOptions
wantErr bool
}{
{
name: "Both From and To nil",
options: smsgateway.ListMessagesOptions{},
wantErr: false,
},
{
name: "From before To",
options: smsgateway.ListMessagesOptions{
From: &from,
To: &to,
},
wantErr: false,
},
{
name: "From after To",
options: smsgateway.ListMessagesOptions{
From: &to,
To: &from,
},
wantErr: true,
},
{
name: "From equal to To",
options: smsgateway.ListMessagesOptions{
From: &from,
To: &from,
},
wantErr: false,
},
{
name: "Only From set",
options: smsgateway.ListMessagesOptions{
From: &from,
},
wantErr: false,
},
{
name: "Only To set",
options: smsgateway.ListMessagesOptions{
To: &to,
},
wantErr: false,
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
err := tt.options.Validate()

if tt.wantErr {
if err == nil {
t.Errorf("Validate() error = nil, wantErr %v", tt.wantErr)
return
}

if !errors.Is(err, smsgateway.ErrValidationFailed) {
t.Errorf("Validate() error = %v, want error type %v", err, smsgateway.ErrValidationFailed)
}
} else if err != nil {
t.Errorf("Validate() error = %v, wantErr %v", err, tt.wantErr)
}
})
}
}

func TestListMessagesOptions_ToURLValues(t *testing.T) {
from := time.Date(2024, 1, 1, 0, 0, 0, 0, time.UTC)
to := time.Date(2024, 12, 31, 23, 59, 59, 0, time.UTC)
state := "Sent"
deviceID := "abc123def456ghi789j"

tests := []struct {
name string
options smsgateway.ListMessagesOptions
expected url.Values
}{
{
name: "No options",
options: smsgateway.ListMessagesOptions{},
expected: url.Values{},
},
{
name: "From set",
options: smsgateway.ListMessagesOptions{
From: &from,
},
expected: url.Values{
"from": {from.Format(time.RFC3339)},
},
},
{
name: "To set",
options: smsgateway.ListMessagesOptions{
To: &to,
},
expected: url.Values{
"to": {to.Format(time.RFC3339)},
},
},
{
name: "State set",
options: smsgateway.ListMessagesOptions{
State: &state,
},
expected: url.Values{
"state": {"Sent"},
},
},
{
name: "DeviceID set",
options: smsgateway.ListMessagesOptions{
DeviceID: &deviceID,
},
expected: url.Values{
"deviceId": {deviceID},
},
},
{
name: "Limit set",
options: smsgateway.ListMessagesOptions{
Limit: ptr(25),
},
expected: url.Values{
"limit": {"25"},
},
},
{
name: "Offset set",
options: smsgateway.ListMessagesOptions{
Offset: ptr(5),
},
expected: url.Values{
"offset": {"5"},
},
},
{
name: "IncludeContent true",
options: smsgateway.ListMessagesOptions{
IncludeContent: ptr(true),
},
expected: url.Values{
"includeContent": {"true"},
},
},
{
name: "IncludeContent false",
options: smsgateway.ListMessagesOptions{
IncludeContent: ptr(false),
},
expected: url.Values{
"includeContent": {"false"},
},
},
{
name: "All fields set",
options: smsgateway.ListMessagesOptions{
From: &from,
To: &to,
State: &state,
DeviceID: &deviceID,
Limit: ptr(100),
Offset: ptr(0),
IncludeContent: ptr(true),
},
expected: url.Values{
"from": {from.Format(time.RFC3339)},
"to": {to.Format(time.RFC3339)},
"state": {"Sent"},
"deviceId": {deviceID},
"limit": {"100"},
"offset": {"0"},
"includeContent": {"true"},
},
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
result := tt.options.ToURLValues()

if !reflect.DeepEqual(result, tt.expected) {
t.Errorf("ToURLValues() = %v, expected %v", result, tt.expected)
Expand Down
Loading