Merge pull request #2 from atselvan/feature/sync

Feature/sync

README.md

@@ -88,3 +88,13 @@ if restErr != nil {
 	log.Fatal(restErr)
 }
 ```
+
+### Sync local data to Anki Cloud
+```go
+client := ankiconnect.NewClient()
+
+restErr := client.Sync.Trigger()
+if restErr != nil {
+	log.Fatal(restErr)
+}
+```

client.go

@@ -26,6 +26,7 @@ type (
 		// supported interfaces
 		Decks DecksManager
 		Notes NotesManager
+		Sync SyncManager
 	}
 
 	// RequestPayload represents the request payload for anki connect api.
@@ -58,6 +59,7 @@ func NewClient() *Client {
 
 	c.Decks = &decksManager{Client: c}
 	c.Notes = &notesManager{Client: c}
+	c.Sync = &syncManager{Client: c}
 
 	return c
 }
@@ -94,6 +96,13 @@ func (c *Client) SetNotesManager(nm NotesManager) *Client {
 	return c
 }
 
+// SetSyncManager can be used to set a custom SyncManager interface.
+// This function is added for testing the SyncManager interface.
+func (c *Client) SetSyncManager(sm SyncManager) *Client {
+	c.Sync = sm
+	return c
+}
+
 // request formats and returns a base http request that can be extended later.
 // as part of this the baseUrl and the default headers are set in the http client.
 func (c *Client) request() *resty.Request {

client_test.go

@@ -53,6 +53,12 @@ func TestClient_SetNotesManager(t *testing.T) {
 	assert.Exactly(t, nm, c.Notes)
 }
 
+func TestClient_SetSyncManager(t *testing.T) {
+	sm := &syncManager{}
+	c := NewClient().SetSyncManager(sm)
+	assert.Exactly(t, sm, c.Sync)
+}
+
 func TestClient_Ping(t *testing.T) {
 	t.Run("success", func(t *testing.T) {
 		c := NewClient()

sync.go

@@ -0,0 +1,31 @@
+package ankiconnect
+
+import "github.com/privatesquare/bkst-go-utils/utils/errors"
+
+const (
+	ActionSync = "sync"
+)
+
+type (
+	// SyncManager describes the interface that can be used to perform sync operations on Anki.
+	SyncManager interface {
+		Trigger() *errors.RestErr
+	}
+
+	// syncManager implements SyncManager
+	syncManager struct{
+		Client *Client
+	}
+)
+
+// Trigger syncs local Anki data to Anki web.
+// The method returns an error if:
+//	- the api request to ankiconnect fails.
+//	- the api returns a http error.
+func (sm *syncManager) Trigger() *errors.RestErr {
+	_, restErr := post[string, ParamsDefault](sm.Client, ActionSync, nil)
+	if restErr != nil {
+		return restErr
+	}
+	return nil
+}

sync_test.go

@@ -0,0 +1,42 @@
+package ankiconnect
+
+import (
+	"net/http"
+	"testing"
+
+	"github.com/jarcoal/httpmock"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestSyncManager_Trigger(t *testing.T) {
+	t.Run("success", func(t *testing.T) {
+		httpmock.ActivateNonDefault(client.httpClient.GetClient())
+		defer httpmock.DeactivateAndReset()
+
+		result := new(Result[string])
+		responder, err := httpmock.NewJsonResponder(http.StatusOK, result)
+		assert.NoError(t, err)
+
+		httpmock.RegisterResponder(http.MethodPost, ankiConnectUrl, responder)
+
+		restErr := client.Sync.Trigger()
+		assert.Nil(t, restErr)
+	})
+
+	t.Run("error", func(t *testing.T) {
+		httpmock.ActivateNonDefault(client.httpClient.GetClient())
+		defer httpmock.DeactivateAndReset()
+
+		result := new(Result[string])
+		loadTestData(t, testDataPath+errorTestDataFileName, result)
+		responder, err := httpmock.NewJsonResponder(http.StatusOK, result)
+		assert.NoError(t, err)
+
+		httpmock.RegisterResponder(http.MethodPost, ankiConnectUrl, responder)
+
+		restErr := client.Sync.Trigger()
+		assert.NotNil(t, restErr)
+		assert.Equal(t, http.StatusBadRequest, restErr.StatusCode)
+		assert.Equal(t, "some error message", restErr.Message)
+	})
+}