Skip to content
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.

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

Add list messages endpoint #36

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions api/api.go
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ func (s Server) Handler() http.Handler {

r.Route("/messages", func(r chi.Router) {
r.Use(mw.Authenticate(s.apps))
r.Get("/", handlers.ListMessages(s.messages))
r.Post("/send", handlers.SendHandler(s.service, s.messages, s.apps))
r.Get("/serial/{id}", handlers.GetMessageBySerialID(s.messages))
r.Get("/{id}", handlers.GetMessageByProviderID(s.messages))
Expand Down
4 changes: 2 additions & 2 deletions api/handlers/handlers_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ func TestSendHander(t *testing.T) {
sender := mock.NewMockSendService(controller)
sender.EXPECT().Send(gomock.Any(), gomock.Any()).Return(dummyReport, nil)

messages := mock.NewMockStore(controller)
messages := mock.NewMockMessageStore(controller)
messages.EXPECT().Insert(gomock.Any(), gomock.Any()).Return(dummyMessage, nil)

apps := mock.NewMockAppStore(controller)
Expand Down Expand Up @@ -169,7 +169,7 @@ func TestDeliveryHandler(t *testing.T) {
ps := mock.NewMockPubsub(controller)
ps.EXPECT().Publish(gomock.Any(), gomock.Any())

store := mock.NewMockStore(controller)
store := mock.NewMockMessageStore(controller)
store.EXPECT().MessageByID(gomock.Any(), gomock.Any()).Return(dummyMessage, nil)
store.EXPECT().Update(gomock.Any(), gomock.Any()).Return(dummyMessage, nil)

Expand Down
23 changes: 23 additions & 0 deletions api/handlers/sms.go
Original file line number Diff line number Diff line change
Expand Up @@ -144,3 +144,26 @@ func GetMessageByProviderID(store hermes.MessageStore) http.HandlerFunc {
render.JSON(w, msg, 200)
}
}

func ListMessages(store hermes.MessageStore) http.HandlerFunc {
const op = "handlers.ListMessages"

return func(w http.ResponseWriter, r *http.Request) {
ctx, span := observ.StartSpan(r.Context(), op)
defer span.End()

var opts = new(hermes.ListOptions)

// get the query params:?
// ?&offset=0&limit=10&status=delivered

msgs, err := store.List(ctx, opts)
if err != nil {
log.Printf("failed to get sms %v", err)
span.RecordError(err)
render.HttpError(w, err)
return
}
render.JSON(w, msgs, 200)
}
}
65 changes: 65 additions & 0 deletions messages.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package hermes
import (
"context"
"fmt"
"strconv"
"time"

"github.com/rugwirobaker/hermes/observ"
Expand All @@ -21,6 +22,17 @@ type Message struct {
UpdateAt time.Time `json:"updated_at"`
}

type ListOptions struct {
// Limit the number of results
Limit int
// Offset the results
Offset int
// Filter by status
// Status Status
// // Filter by phone
// Phone string
}

type MessageStore interface {
// Insert a new message
Insert(context.Context, *Message) (*Message, error)
Expand All @@ -32,6 +44,8 @@ type MessageStore interface {
MessageByID(context.Context, string) (*Message, error)
// Update a message(set status to delivered/failed)
Update(context.Context, *Message) (*Message, error)
// List messages
List(context.Context, *ListOptions) ([]*Message, error)
}

func NewStore(db *sqlite.DB) MessageStore {
Expand Down Expand Up @@ -202,3 +216,54 @@ func (s *store) Update(ctx context.Context, u *Message) (*Message, error) {

return u, tx.Commit()
}

func (s *store) List(ctx context.Context, opts *ListOptions) ([]*Message, error) {
const op = "store.List"

ctx, span := observ.StartSpan(ctx, op)
defer span.End()

tx, err := s.db.BeginTx(ctx, sqlite.TxOptions(true))
if err != nil {
return nil, err
}
defer tx.Rollback()

var out []*Message

query := "SELECT id, provider_id, phone, payload, cost, status, created_at, updated_at FROM messages"
if opts.Limit > 0 {
query += " LIMIT " + strconv.Itoa(opts.Limit)
}
if opts.Offset > 0 {
query += " OFFSET " + strconv.Itoa(opts.Offset)
}

rows, err := tx.QueryContext(ctx, query)
if err != nil {
return nil, fmt.Errorf("list: %w", err)
}
defer rows.Close()

for rows.Next() {
var m Message
err := rows.Scan(
&m.ID,
&m.ProviderID,
&m.Recipient,
&m.Payload,
&m.Cost,
&m.Status,
&m.CreatedAt,
&m.UpdateAt,
)
if err != nil {
return nil, fmt.Errorf("list: %w", err)
}
out = append(out, &m)
}
if err := rows.Err(); err != nil {
return nil, fmt.Errorf("list: %w", err)
}
return out, tx.Commit()
}
2 changes: 1 addition & 1 deletion mock/mock.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
package mock

//go:generate mockgen -package=mock -destination=mock_gen.go github.com/rugwirobaker/hermes SendService,Pubsub,AppStore,Store
//go:generate mockgen -package=mock -destination=mock_gen.go github.com/rugwirobaker/hermes SendService,Pubsub,AppStore,MessageStore
69 changes: 42 additions & 27 deletions mock/mock_gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.