feat: add a single API endpoint to return a list of sparkles

2 files changed, 101 insertions, 0 deletions

diff --git a/pkg/domain/sparkle.go b/pkg/domain/sparkle.go
new file mode 100644
index 0000000..54ccb13
--- /dev/null
+++ b/pkg/domain/sparkle.go
@@ -0,0 +1,50 @@
+package domain
+
+import (
+	"errors"
+	"regexp"
+
+	"gitlab.com/mokhax/sparkled/pkg/pls"
+)
+
+type Sparkle struct {
+	ID       string `json:"id" jsonapi:"primary,sparkles"`
+	Sparklee string `json:"sparklee" jsonapi:"attr,sparklee"`
+	Reason   string `json:"reason" jsonapi:"attr,reason"`
+}
+
+var SparkleRegex = regexp.MustCompile(`\A\s*(?P<sparklee>@\w+)\s+(?P<reason>.+)\z`)
+var SparkleeIndex = SparkleRegex.SubexpIndex("sparklee")
+var ReasonIndex = SparkleRegex.SubexpIndex("reason")
+
+var ReasonIsRequired = errors.New("Reason is required")
+var SparkleIsEmpty = errors.New("Sparkle is empty")
+var SparkleIsInvalid = errors.New("Sparkle is invalid")
+var SparkleeIsRequired = errors.New("Sparklee is required")
+
+func NewSparkle(text string) (*Sparkle, error) {
+	if len(text) == 0 {
+		return nil, SparkleIsEmpty
+	}
+
+	matches := SparkleRegex.FindStringSubmatch(text)
+	if len(matches) == 0 {
+		return nil, SparkleIsInvalid
+	}
+
+	return &Sparkle{
+		ID:       pls.GenerateULID(),
+		Sparklee: matches[SparkleeIndex],
+		Reason:   matches[ReasonIndex],
+	}, nil
+}
+
+func (s *Sparkle) Validate() error {
+	if s.Sparklee == "" {
+		return SparkleeIsRequired
+	}
+	if s.Reason == "" {
+		return ReasonIsRequired
+	}
+	return nil
+}
diff --git a/pkg/domain/sparkle_test.go b/pkg/domain/sparkle_test.go
new file mode 100644
index 0000000..8d81afd
--- /dev/null
+++ b/pkg/domain/sparkle_test.go
@@ -0,0 +1,51 @@
+package domain
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestSparkle(t *testing.T) {
+	t.Run("NewSparkle", func(t *testing.T) {
+		t.Run("with a valid body", func(t *testing.T) {
+			sparkle, err := NewSparkle("@tanuki for helping me with my homework!")
+
+			assert.Nil(t, err)
+			if err != nil {
+				assert.Equal(t, "@tanuki", sparkle.Sparklee)
+				assert.Equal(t, "for helping me with my homework!", sparkle.Reason)
+			}
+		})
+
+		t.Run("with an empty body", func(t *testing.T) {
+			sparkle, err := NewSparkle("")
+
+			assert.Nil(t, sparkle)
+			assert.NotNil(t, err)
+			if err != nil {
+				assert.Equal(t, "Sparkle is empty", err.Error())
+			}
+		})
+
+		t.Run("without a reason", func(t *testing.T) {
+			sparkle, err := NewSparkle("@tanuki")
+
+			assert.Nil(t, sparkle)
+			assert.NotNil(t, err)
+			if err != nil {
+				assert.Equal(t, "Sparkle is invalid", err.Error())
+			}
+		})
+
+		t.Run("without a username", func(t *testing.T) {
+			sparkle, err := NewSparkle("for helping me with my homework")
+
+			assert.Nil(t, sparkle)
+			assert.NotNil(t, err)
+			if err != nil {
+				assert.Equal(t, "Sparkle is invalid", err.Error())
+			}
+		})
+	})
+}