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.

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

Fix groups for create #35

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Fix groups for create #35

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fd5329c
add a separate type for creating a subscriber
roblaszczak Dec 6, 2024
6387815
chore: Merge branch 'main' into fix-groups-for-create
robgordon89 Dec 19, 2024
a6e5cf6
chore: add tests and chnage to upsert
robgordon89 Dec 19, 2024
91641b1
chore: add context and deprecate interface
robgordon89 Dec 31, 2024
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
11 changes: 6 additions & 5 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ func main() {
}
```

### Create a subscriber
### Create/Upsert a subscriber

```go
package main
Expand All @@ -192,14 +192,14 @@ func main() {

ctx := context.TODO()

subscriber := &mailerlite.Subscriber{
subscriber := &mailerlite.UpsertSubscriber{
Email: "[email protected]",
Fields: map[string]interface{}{
"city": "Vilnius",
},
}

newSubscriber, _, err := client.Subscriber.Create(ctx, subscriber)
newSubscriber, _, err := client.Subscriber.Upsert(ctx, subscriber)
if err != nil {
log.Fatal(err)
}
Expand Down Expand Up @@ -227,14 +227,15 @@ func main() {

ctx := context.TODO()

subscriber := &mailerlite.Subscriber{
subscriber := &mailerlite.UpdateSubscriber{
ID: "1",
Email: "[email protected]",
Fields: map[string]interface{}{
"company": "MailerLite",
},
}

newSubscriber, _, err := client.Subscriber.Create(ctx, subscriber)
newSubscriber, _, err := client.Subscriber.Update(ctx, subscriber)
if err != nil {
log.Fatal(err)
}
Expand Down
36 changes: 32 additions & 4 deletions subscribers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ type SubscriberService interface {
Count(ctx context.Context) (*Count, *Response, error)
Get(ctx context.Context, options *GetSubscriberOptions) (*RootSubscriber, *Response, error)
Create(ctx context.Context, subscriber *Subscriber) (*RootSubscriber, *Response, error)
Update(ctx context.Context, subscriber *Subscriber) (*RootSubscriber, *Response, error)
Upsert(ctx context.Context, subscriber *UpsertSubscriber) (*RootSubscriber, *Response, error)
Update(ctx context.Context, subscriber *UpdateSubscriber) (*RootSubscriber, *Response, error)
Delete(ctx context.Context, subscriberID string) (*Response, error)
Forget(ctx context.Context, subscriberID string) (*RootSubscriber, *Response, error)
}
Expand Down Expand Up @@ -61,6 +62,21 @@ type Subscriber struct {
OptinIP string `json:"optin_ip,omitempty"`
}

type UpdateSubscriber UpsertSubscriber

type UpsertSubscriber struct {
ID string `json:"id,omitempty"`
Email string `json:"email,omitempty"`
Status string `json:"status,omitempty"`
IPAddress interface{} `json:"ip_address,omitempty"`
SubscribedAt string `json:"subscribed_at,omitempty"`
UnsubscribedAt interface{} `json:"unsubscribed_at,omitempty"`
Fields map[string]interface{} `json:"fields,omitempty"`
Groups []string `json:"groups,omitempty"`
OptedInAt string `json:"opted_in_at,omitempty"`
OptinIP string `json:"optin_ip,omitempty"`
}

// ListSubscriberOptions - modifies the behavior of SubscriberService.List method
type ListSubscriberOptions struct {
Filters *[]Filter `json:"filters,omitempty"`
Expand Down Expand Up @@ -127,6 +143,7 @@ func (s *subscriberService) Get(ctx context.Context, options *GetSubscriberOptio
return root, res, nil
}

// Deprecated: use Upsert instead
robgordon89 marked this conversation as resolved.
Show resolved Hide resolved
func (s *subscriberService) Create(ctx context.Context, subscriber *Subscriber) (*RootSubscriber, *Response, error) {
req, err := s.client.newRequest(http.MethodPost, subscriberEndpoint, subscriber)
if err != nil {
Expand All @@ -142,11 +159,22 @@ func (s *subscriberService) Create(ctx context.Context, subscriber *Subscriber)
return root, res, nil
}

func (s *subscriberService) Upsert(ctx context.Context, subscriber *Subscriber) (*RootSubscriber, *Response, error) {
return s.Create(ctx, subscriber)
func (s *subscriberService) Upsert(ctx context.Context, subscriber *UpsertSubscriber) (*RootSubscriber, *Response, error) {
req, err := s.client.newRequest(http.MethodPost, subscriberEndpoint, subscriber)
if err != nil {
return nil, nil, err
}

root := new(RootSubscriber)
res, err := s.client.do(ctx, req, root)
if err != nil {
return nil, res, err
}

return root, res, nil
}

func (s *subscriberService) Update(ctx context.Context, subscriber *Subscriber) (*RootSubscriber, *Response, error) {
func (s *subscriberService) Update(ctx context.Context, subscriber *UpdateSubscriber) (*RootSubscriber, *Response, error) {
path := fmt.Sprintf("%s/%s", subscriberEndpoint, subscriber.ID)

req, err := s.client.newRequest(http.MethodPut, path, subscriber)
Expand Down
65 changes: 64 additions & 1 deletion subscribers_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ func TestCanForgetSubscrber(t *testing.T) {
assert.Equal(t, res.StatusCode, http.StatusOK)
}

func TestCanCreateSubscrberWithGroup(t *testing.T) {
func TestCanCreateSubscrberWithGroupDeprecated(t *testing.T) {
client := mailerlite.NewClient(testKey)

testClient := NewTestClient(func(req *http.Request) *http.Response {
Expand Down Expand Up @@ -198,3 +198,66 @@ func TestCanCreateSubscrberWithGroup(t *testing.T) {

assert.Equal(t, res.StatusCode, http.StatusOK)
}

func TestCanUpsertSubscrberWithGroup(t *testing.T) {
client := mailerlite.NewClient(testKey)

testClient := NewTestClient(func(req *http.Request) *http.Response {
assert.Equal(t, req.Method, http.MethodPost)
assert.Equal(t, req.URL.String(), "https://connect.mailerlite.com/api/subscribers")
b, _ := io.ReadAll(req.Body)
assert.Equal(t, strings.TrimRight(string(b), "\r\n"), `{"email":"[email protected]","groups":["1234"]}`)
return &http.Response{
StatusCode: http.StatusOK,
Body: io.NopCloser(bytes.NewBufferString(`OK`)),
}
})

ctx := context.TODO()

client.SetHttpClient(testClient)

options := &mailerlite.UpsertSubscriber{
Email: "[email protected]",
Groups: []string{"1234"},
}

_, res, err := client.Subscriber.Upsert(ctx, options)
if err != nil {
return
}

assert.Equal(t, res.StatusCode, http.StatusOK)
}

func TestCanUpdateSubscrberWithGroup(t *testing.T) {
client := mailerlite.NewClient(testKey)

testClient := NewTestClient(func(req *http.Request) *http.Response {
assert.Equal(t, req.Method, http.MethodPut)
assert.Equal(t, req.URL.String(), "https://connect.mailerlite.com/api/subscribers/1")
b, _ := io.ReadAll(req.Body)
assert.Equal(t, strings.TrimRight(string(b), "\r\n"), `{"id":"1","email":"[email protected]","groups":["1234"]}`)
return &http.Response{
StatusCode: http.StatusOK,
Body: io.NopCloser(bytes.NewBufferString(`OK`)),
}
})

ctx := context.TODO()

client.SetHttpClient(testClient)

options := &mailerlite.UpdateSubscriber{
ID: "1",
Email: "[email protected]",
Groups: []string{"1234"},
}

_, res, err := client.Subscriber.Update(ctx, options)
if err != nil {
return
}

assert.Equal(t, res.StatusCode, http.StatusOK)
}