Merge pull request #7 from simodima/rename

Renames to github.com/simodima

Author: simodima

README.md

@@ -9,7 +9,7 @@
 ---
 
 [![codecov](https://codecov.io/github/simodima/squeue/graph/badge.svg?token=DW7C57P2VW)](https://codecov.io/github/simodima/squeue)
-[![Go Report Card](https://goreportcard.com/badge/github.com/toretto460/squeue)](https://goreportcard.com/report/github.com/toretto460/squeue)
+[![Go Report Card](https://goreportcard.com/badge/github.com/simodima/squeue)](https://goreportcard.com/report/github.com/simodima/squeue)
 [![Go Reference](https://pkg.go.dev/badge/github.com/simodima/squeue.svg)](https://pkg.go.dev/github.com/simodima/squeue)
 
 The library provides the following features:

consumer.go

@@ -4,12 +4,12 @@ import (
 	"context"
 	"encoding/json"
 
-	"github.com/toretto460/squeue/driver"
+	"github.com/simodima/squeue/driver"
 )
 
 //go:generate mockgen -source=driver/driver.go -package=squeue_test -destination=driver_test.go
 
-// NewConsumer
+// NewConsumer creates a new consumer for the given T type of messages
 func NewConsumer[T json.Unmarshaler](d driver.Driver) Consumer[T] {
 	return Consumer[T]{d}
 }
@@ -18,7 +18,11 @@ type Consumer[T json.Unmarshaler] struct {
 	driver driver.Driver
 }
 
-// TODO: document Consume
+// Consume retrieves messages from the given queue.
+// Any provided options will be sent to the underlying driver.
+// The messages are indefinetely consumed from the queue and
+// sent to the chan Message[T].
+// To stop consuming messages is sufficient to cancel the context.Context
 func (p *Consumer[T]) Consume(ctx context.Context, queue string, opts ...func(message any)) (chan Message[T], error) {
 	messages, err := p.driver.Consume(ctx, queue, opts...)
 	if err != nil {
@@ -57,7 +61,8 @@ func (p *Consumer[T]) Consume(ctx context.Context, queue string, opts ...func(me
 	return outMsg, nil
 }
 
-// TODO: document Ack
+// Ack explicitly acknowldge the message handling.
+// It can be implemented as No Operation for some drivers.
 func (p *Consumer[T]) Ack(queue string, m Message[T]) error {
 	return p.driver.Ack(queue, m.ID)
 }

consumer_test.go

@@ -8,8 +8,8 @@ import (
 	"github.com/golang/mock/gomock"
 	"github.com/stretchr/testify/suite"
 
-	"github.com/toretto460/squeue"
-	"github.com/toretto460/squeue/driver"
+	"github.com/simodima/squeue"
+	"github.com/simodima/squeue/driver"
 )
 
 type ConsumerTestSuite struct {

driver/memdriver_test.go

@@ -5,8 +5,8 @@ import (
 	"testing"
 	"time"
 
+	"github.com/simodima/squeue/driver"
 	"github.com/stretchr/testify/suite"
-	"github.com/toretto460/squeue/driver"
 )
 
 type MemoryTestSuite struct {

driver_test.go

@@ -1,4 +1,4 @@
-module github.com/toretto460/squeue
+module github.com/simodima/squeue
 
 go 1.18
 

go.mod

@@ -9,8 +9,8 @@ import (
 	"syscall"
 	"time"
 
-	"github.com/toretto460/squeue"
-	"github.com/toretto460/squeue/driver"
+	"github.com/simodima/squeue"
+	"github.com/simodima/squeue/driver"
 )
 
 type myMessage struct {

internal/examples/memory/main.go

@@ -8,9 +8,9 @@ import (
 	"syscall"
 
 	"github.com/joho/godotenv"
-	"github.com/toretto460/squeue"
-	sqsexample "github.com/toretto460/squeue/internal/examples/sqs"
-	"github.com/toretto460/squeue/sqs"
+	"github.com/simodima/squeue"
+	sqsexample "github.com/simodima/squeue/internal/examples/sqs"
+	"github.com/simodima/squeue/sqs"
 )
 
 func cancelOnSignal(fn func(), signals ...os.Signal) {

internal/examples/sqs/consumer/consumer.go

@@ -8,9 +8,9 @@ import (
 
 	"github.com/joho/godotenv"
 
-	"github.com/toretto460/squeue"
-	sqsexample "github.com/toretto460/squeue/internal/examples/sqs"
-	"github.com/toretto460/squeue/sqs"
+	"github.com/simodima/squeue"
+	sqsexample "github.com/simodima/squeue/internal/examples/sqs"
+	"github.com/simodima/squeue/sqs"
 )
 
 func init() {

internal/examples/sqs/producer/producer.go

@@ -3,7 +3,7 @@ package squeue
 import (
 	"encoding/json"
 
-	"github.com/toretto460/squeue/driver"
+	"github.com/simodima/squeue/driver"
 )
 
 func NewProducer(d driver.Driver) Producer {
@@ -16,7 +16,9 @@ type Producer struct {
 	driver driver.Driver
 }
 
-// TODO: document Enqueue
+// Enqueue sends a message to the given queue
+// any provided options will be sent to the
+// underlying driver
 func (q *Producer) Enqueue(queue string, message json.Marshaler, opts ...func(message any)) error {
 	data, err := json.Marshal(message)
 	if err != nil {