feat(delete): implement delete interface (#15)

* feat(delete): implement delete interface

* chore: Updated coverage badge.

Co-authored-by: Muhammad Ikhsan <muhammad.ikhsan@efishery.com>
Co-authored-by: GitHub Action <action@github.com>

Author: 3 people

README.md

@@ -1,4 +1,4 @@
-![Coverage](https://img.shields.io/badge/Coverage-86.3%25-brightgreen)
+![Coverage](https://img.shields.io/badge/Coverage-85.7%25-brightgreen)
 # gostein
 
 [Stein](https://steinhq.com/) API wrapper for Go.
@@ -80,6 +80,7 @@ resp, err = steinClient.Add("sheet1", rows...)
 ...
 ```
 ### Update
+The update operation return string that indicate ranges of the sheet that was updated. Example: `Sheet1!A3:B3`.
 #### Update single row
 `Limit 1` indicate to update only the first row that match the `Condition`.
 ```go
@@ -113,11 +114,40 @@ resp, err := sc.Update("Sheet1", UpdateParams{
 ...
 ```
 > :warning: **If `Limit` is not set, all rows those match the `Condition` will be updated.**
+### Delete
+The delete operation return int64 that indicate the number of rows that was deleted.
+#### Delete single row
+`Limit 1` indicate to update only the first row that match the `Condition`.
+```go
+...
+resp, err := sc.Delete("Sheet1", DeleteParams{
+			Condition: map[string]string{
+				"column_1": "if_has_this_value",
+			},
+			Limit: 1,
+		})
+// handle err and do something with resp
+...
+```
+#### Update with multiple condition
+All `Condition` will be translated to `AND` condition.
+```go
+...
+resp, err := sc.Delete("Sheet1", DeleteParams{
+			Condition: map[string]string{
+				"column_1": "if_has_this_value",
+				"column_3": "and_if_has_this_value",
+			},
+		})
+// handle err and do something with resp
+...
+```
+> :warning: **If `Limit` is not set, all rows those match the `Condition` will be deleted.**
 
 ## TODO
 - [x] Read data (https://docs.steinhq.com/read-data)
 - [x] Read data with conditions (https://docs.steinhq.com/search-data)
 - [x] Add data (https://docs.steinhq.com/add-rows)
 - [x] Update data (https://docs.steinhq.com/update-rows)
-- [ ] Delete data (https://docs.steinhq.com/delete-rows)
+- [x] Delete data (https://docs.steinhq.com/delete-rows)
 - [ ] Authentication (https://docs.steinhq.com/authentication)

stein.go

@@ -10,10 +10,16 @@ import (
 	"strings"
 )
 
+// UpsertResponse is the response from the either Update or Insert/add operation
+type UpsertResponse struct {
+	UpdatedRange string `json:"updatedRange"`
+}
+
+// GetParams is the parameters for the read operations: Get or search
 type GetParams struct {
 	Offset int64
 	Limit  int64
-	Search map[string]string
+	Condition map[string]string
 }
 
 // builds the query string from the given params with query string escaping
@@ -27,8 +33,8 @@ func (gp GetParams) queryString() string {
 		queryString = queryString + fmt.Sprintf("limit=%d&", gp.Limit)
 	}
 
-	if len(gp.Search) > 0 {
-		jsonSearch, err := json.Marshal(gp.Search)
+	if len(gp.Condition) > 0 {
+		jsonSearch, err := json.Marshal(gp.Condition)
 		if err != nil {
 			return ""
 		}
@@ -41,21 +47,25 @@ func (gp GetParams) queryString() string {
 	return removeSuffix(queryString, "&")
 }
 
-type WriteResponse struct {
-	UpdatedRange string `json:"updatedRange"`
-}
-
+// UpdateParams is the parameters for the update operation
 type UpdateParams struct {
 	Condition map[string]string `json:"condition"`
 	Set       map[string]string `json:"set"`
 	Limit     int64             `json:"limit,omitempty"`
 }
 
+// DeleteParams is the parameters for the delete operation
+type DeleteParams struct {
+	Condition map[string]string `json:"condition"`
+	Limit     int64             `json:"limit,omitempty"`
+}
+
 // Interface is the interface for the stein client
 type Interface interface {
 	Get(sheet string, params GetParams) ([]map[string]interface{}, error)
-	Add(sheet string, rows ...map[string]interface{}) (WriteResponse, error)
-	Update(sheet string, params UpdateParams) (WriteResponse, error)
+	Add(sheet string, rows ...map[string]interface{}) (UpsertResponse, error)
+	Update(sheet string, params UpdateParams) (UpsertResponse, error)
+	Delete(sheet string, params DeleteParams) (countDeletedRows int64, err error)
 }
 
 type stein struct {
@@ -113,9 +123,9 @@ func (s *stein) Get(sheet string, params GetParams) ([]map[string]interface{}, e
 	return data, nil
 }
 
-func (s *stein) Add(sheet string, rows ...map[string]interface{}) (WriteResponse, error) {
+func (s *stein) Add(sheet string, rows ...map[string]interface{}) (UpsertResponse, error) {
 	var (
-		result WriteResponse
+		result UpsertResponse
 		resource = fmt.Sprintf("%s/%s", s.url, removePrefix(sheet, "/"))
 	)
 
@@ -143,9 +153,9 @@ func (s *stein) Add(sheet string, rows ...map[string]interface{}) (WriteResponse
 	return result, nil
 }
 
-func (s *stein) Update(sheet string, params UpdateParams) (WriteResponse, error) {
+func (s *stein) Update(sheet string, params UpdateParams) (UpsertResponse, error) {
 	var (
-		result WriteResponse
+		result UpsertResponse
 		resource = fmt.Sprintf("%s/%s", s.url, removePrefix(sheet, "/"))
 	)
 
@@ -172,8 +182,46 @@ func (s *stein) Update(sheet string, params UpdateParams) (WriteResponse, error)
 
 	err = s.decodeJSON(resp.Body, &result)
 	if err != nil {
-		return WriteResponse{}, ErrDecodeJSON{Err: err}
+		return UpsertResponse{}, ErrDecodeJSON{Err: err}
 	}
 
 	return result, nil
 }
+
+func (s *stein) Delete(sheet string, params DeleteParams) (countDeletedRows int64, err error) {
+	var (
+		result = struct {
+			CountDeletedRows int64 `json:"clearedRowsCount"`
+		}{}
+
+		resource = fmt.Sprintf("%s/%s", s.url, removePrefix(sheet, "/"))
+	)
+
+	payload, err := json.Marshal(params)
+	if err != nil {
+		return countDeletedRows, err
+	}
+
+	req, err := http.NewRequest(http.MethodDelete, resource, bytes.NewBuffer(payload))
+	if err != nil {
+		return countDeletedRows, err
+	}
+	req.Header.Set("Content-Type", "application/json")
+
+	resp, err := s.httpClient.Do(req)
+	if err != nil {
+		return countDeletedRows, err
+	}
+	defer resp.Body.Close()
+
+	if resp.StatusCode != http.StatusOK {
+		return countDeletedRows, ErrNot2XX{StatusCode: resp.StatusCode}
+	}
+
+	err = s.decodeJSON(resp.Body, &result)
+	if err != nil {
+		return countDeletedRows, ErrDecodeJSON{Err: err}
+	}
+
+	return result.CountDeletedRows, nil
+}

stein_test.go

@@ -78,7 +78,7 @@ func TestSearchParams_queryString(t *testing.T) {
 		params := GetParams{
 			Offset: 20,
 			Limit:  10,
-			Search: map[string]string{
+			Condition: map[string]string{
 				"column_1": "value_column_1",
 				"column_2": "value_column_2",
 			},
@@ -205,3 +205,56 @@ func Test_stein_Update(t *testing.T) {
 		}
 	})
 }
+
+func Test_stein_Delete(t *testing.T) {
+	t.Run("should return the correct response", func(t *testing.T) {
+		ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+			jsonBody := `{"clearedRowsCount": 345}`
+
+			w.Header().Set("Content-Type", "application/json")
+			w.WriteHeader(http.StatusOK)
+			_, _ = w.Write([]byte(jsonBody))
+		}))
+		defer ts.Close()
+
+		sc := New(ts.URL, nil)
+		resp, err := sc.Delete("Sheet1", DeleteParams{})
+		if err != nil {
+			t.Errorf("Error: %v", err)
+		}
+
+		assert.Equal(t, int64(345), resp)
+	})
+
+	t.Run("should return error if http code not 2xx", func(t *testing.T) {
+		ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+			w.WriteHeader(http.StatusForbidden)
+		}))
+		defer ts.Close()
+
+		sc := New(ts.URL, nil)
+		_, err := sc.Delete("sheetname", DeleteParams{})
+		assert.NotNil(t, err)
+		if !errors.As(err, &ErrNot2XX{}) {
+			t.Errorf("Expected ErrNot2XX, got %v", err)
+		}
+	})
+
+	t.Run("should return error on failed decode the response", func(t *testing.T) {
+		ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+			jsonBody := `bad json`
+
+			w.Header().Set("Content-Type", "application/json")
+			w.WriteHeader(http.StatusOK)
+			_, _ = w.Write([]byte(jsonBody))
+		}))
+		defer ts.Close()
+
+		sc := New(ts.URL, nil)
+		_, err := sc.Delete("/sheetname", DeleteParams{})
+		assert.NotNil(t, err)
+		if !errors.As(err, &ErrDecodeJSON{}) {
+			t.Errorf("Expected ErrDecode, got %v", err)
+		}
+	})
+}