Add API for the contacts page

Author: AchoArnold

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: gomod
+    directory: /
+    schedule:
+      interval: monthly

.github/workflows/main.yml

@@ -17,7 +17,7 @@ jobs:
 
       - name: Setup Dependencies
         run: |
-          curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sudo sh -s -- -b $GOPATH/bin v1.24.0
+          curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sudo sh -s -- -b $GOPATH/bin
           golangci-lint --version
           go get golang.org/x/tools/cmd/cover
           go get -t -v ./...

.pre-commit-config.yaml

@@ -1,13 +1,13 @@
 repos:
 - repo: https://github.com/tekwizely/pre-commit-golang
-  rev: master
+  rev: v1.0.0-rc.4
   hooks:
     - id: go-fumpt
     - id: go-mod-tidy
     - id: go-lint
     - id: go-imports
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v2.3.0
+  rev: v6.0.0
   hooks:
     - id: check-yaml
     - id: end-of-file-fixer

README.md

@@ -1,51 +1,64 @@
-# go-http-client
+# plunk-go
 
-[![Build](https://github.com/NdoleStudio/go-http-client/actions/workflows/main.yml/badge.svg)](https://github.com/NdoleStudio/go-http-client/actions/workflows/main.yml)
-[![codecov](https://codecov.io/gh/NdoleStudio/go-http-client/branch/main/graph/badge.svg)](https://codecov.io/gh/NdoleStudio/go-http-client)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/NdoleStudio/go-http-client/badges/quality-score.png?b=main)](https://scrutinizer-ci.com/g/NdoleStudio/go-http-client/?branch=main)
-[![Go Report Card](https://goreportcard.com/badge/github.com/NdoleStudio/go-http-client)](https://goreportcard.com/report/github.com/NdoleStudio/go-http-client)
-[![GitHub contributors](https://img.shields.io/github/contributors/NdoleStudio/go-http-client)](https://github.com/NdoleStudio/go-http-client/graphs/contributors)
-[![GitHub license](https://img.shields.io/github/license/NdoleStudio/go-http-client?color=brightgreen)](https://github.com/NdoleStudio/go-http-client/blob/master/LICENSE)
-[![PkgGoDev](https://pkg.go.dev/badge/github.com/NdoleStudio/go-http-client)](https://pkg.go.dev/github.com/NdoleStudio/go-http-client)
+[![Build](https://github.com/NdoleStudio/plunk-go/actions/workflows/main.yml/badge.svg)](https://github.com/NdoleStudio/plunk-go/actions/workflows/main.yml)
+[![codecov](https://codecov.io/gh/NdoleStudio/plunk-go/branch/main/graph/badge.svg)](https://codecov.io/gh/NdoleStudio/plunk-go)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/NdoleStudio/plunk-go/badges/quality-score.png?b=main)](https://scrutinizer-ci.com/g/NdoleStudio/plunk-go/?branch=main)
+[![Go Report Card](https://goreportcard.com/badge/github.com/NdoleStudio/plunk-go)](https://goreportcard.com/report/github.com/NdoleStudio/plunk-go)
+[![GitHub contributors](https://img.shields.io/github/contributors/NdoleStudio/plunk-go)](https://github.com/NdoleStudio/plunk-go/graphs/contributors)
+[![GitHub license](https://img.shields.io/github/license/NdoleStudio/plunk-go?color=brightgreen)](https://github.com/NdoleStudio/plunk-go/blob/master/LICENSE)
+[![PkgGoDev](https://pkg.go.dev/badge/github.com/NdoleStudio/plunk-go)](https://pkg.go.dev/github.com/NdoleStudio/plunk-go)
 
 
-This package provides a generic `go` client template for an HTTP API
+This is an unofficial client library for interacting with the [Plunk API](https://next-wiki.useplunk.com/) using Go.
+
+![Card](https://www.useplunk.com/assets/card.png)
+
 
 ## Installation
 
-`go-http-client` is compatible with modern Go releases in module mode, with Go installed:
+Make sure your project is using Go Modules (it will have a `go.mod` file in its root if it already is):
 
-```bash
-go get github.com/NdoleStudio/go-http-client
+```sh
+go mod init
 ```
 
-Alternatively the same can be achieved if you use `import` in a package:
+Then, reference plunk-go in a Go program with `import`:
 
 ```go
-import "github.com/NdoleStudio/go-http-client"
+import (
+	"github.com/NdoleStudio/plunk-go"
+)
+```
+
+Run any of the normal `go` commands (`build`/`install`). The Go toolchain will resolve and fetch the plunk-go module automatically. Alternatively, you can also explicitly `go get` the package into a project:
+
+```bash
+go get github.com/NdoleStudio/plunk-go
 ```
 
 
 ## Implemented
 
-- [Status Codes](#status-codes)
-    - `GET /200`: OK
+- Contacts
+    - `POST /contacts`: Create a new contact or update existing (upsert by email)
+    - `DELETE /contacts/{id}`: Permanently delete a contact
+    - `GET /contacts`: Get a paginated list of contacts with cursor-based pagination
 
 ## Usage
 
 ### Initializing the Client
 
-An instance of the client can be created using `New()`.
+An instance of the client can be created using `plunk.New()`.
 
 ```go
 package main
 
 import (
-	"github.com/NdoleStudio/go-http-client"
+	"github.com/NdoleStudio/plunk-go"
 )
 
 func main()  {
-	statusClient := client.New(client.WithDelay(200))
+	plunkClient := plunk.New(plunk.WithSecretKey(/* Secret Key from https://next-app.useplunk.com/settings?tab=general*/))
 }
 ```
 
@@ -54,24 +67,20 @@ func main()  {
 All API calls return an `error` as the last return object. All successful calls will return a `nil` error.
 
 ```go
-status, response, err := statusClient.Status.Ok(context.Background())
-if err != nil {
-    //handle error
+request := &plunk.CreateContactRequest{
+    Email: "[email protected]"
+    Subscribed: true
+    Data: map[string]any{
+        "firstName": "John",
+        "lastName": "Doe",
+        "plan": "premium",
+    }
 }
-```
-
-### Status Codes
-
-#### `GET /200`: OK
-
-```go
-status, response, err := statusClient.Status.Ok(context.Background())
 
+contact, response, err := plunkClient.Contacts.Create(context.Background(), request)
 if err != nil {
-    log.Fatal(err)
+    //handle error
 }
-
-log.Println(status.Description) // OK
 ```
 
 ## Testing

client.go

@@ -6,27 +6,25 @@ import (
 	"encoding/json"
 	"fmt"
 	"io"
-	"io/ioutil"
 	"net/http"
-	"strconv"
 )
 
 type service struct {
 	client *Client
 }
 
-// Client is the campay API client.
-// Do not instantiate this client with Client{}. Use the New method instead.
+// Client is the plunk API client.
+// Do not instantiate this client with Client. Use the New method instead.
 type Client struct {
 	httpClient *http.Client
 	common     service
 	baseURL    string
-	delay      int
+	secretKey  string
 
-	Status *statusService
+	Contacts *contactService
 }
 
-// New creates and returns a new campay.Client from a slice of campay.ClientOption.
+// New creates and returns a new Client from a slice of Option.
 func New(options ...Option) *Client {
 	config := defaultClientConfig()
 
@@ -36,12 +34,12 @@ func New(options ...Option) *Client {
 
 	client := &Client{
 		httpClient: config.httpClient,
-		delay:      config.delay,
+		secretKey:  config.secretKey,
 		baseURL:    config.baseURL,
 	}
 
 	client.common.client = client
-	client.Status = (*statusService)(&client.common)
+	client.Contacts = (*contactService)(&client.common)
 	return client
 }
 
@@ -67,10 +65,7 @@ func (client *Client) newRequest(ctx context.Context, method, uri string, body i
 
 	req.Header.Set("Content-Type", "application/json")
 	req.Header.Set("Accept", "application/json")
-
-	if client.delay > 0 {
-		client.addURLParams(req, map[string]string{"sleep": strconv.Itoa(client.delay)})
-	}
+	req.Header.Set("Authorization", "Bearer "+client.secretKey)
 
 	return req, nil
 }
@@ -103,7 +98,7 @@ func (client *Client) do(req *http.Request) (*Response, error) {
 		return resp, err
 	}
 
-	_, err = io.Copy(ioutil.Discard, httpResponse.Body)
+	_, err = io.Copy(io.Discard, httpResponse.Body)
 	if err != nil {
 		return resp, err
 	}
@@ -120,7 +115,7 @@ func (client *Client) newResponse(httpResponse *http.Response) (*Response, error
 	resp := new(Response)
 	resp.HTTPResponse = httpResponse
 
-	buf, err := ioutil.ReadAll(resp.HTTPResponse.Body)
+	buf, err := io.ReadAll(resp.HTTPResponse.Body)
 	if err != nil {
 		return nil, err
 	}

client_config.go

@@ -4,14 +4,13 @@ import "net/http"
 
 type clientConfig struct {
 	httpClient *http.Client
-	delay      int
+	secretKey  string
 	baseURL    string
 }
 
 func defaultClientConfig() *clientConfig {
 	return &clientConfig{
 		httpClient: http.DefaultClient,
-		delay:      0,
-		baseURL:    "https://httpstat.us",
+		baseURL:    "https://next-api.useplunk.com",
 	}
 }

client_option.go

@@ -35,12 +35,9 @@ func WithBaseURL(baseURL string) Option {
 	})
 }
 
-// WithDelay sets the delay in milliseconds before a response is gotten.
-// The delay must be > 0 for it to be used.
-func WithDelay(delay int) Option {
+// WithSecretKey sets the secret key for API authentication.
+func WithSecretKey(secretKey string) Option {
 	return clientOptionFunc(func(config *clientConfig) {
-		if delay > 0 {
-			config.delay = delay
-		}
+		config.secretKey = secretKey
 	})
 }

client_option_test.go

@@ -71,34 +71,19 @@ func TestWithBaseURL(t *testing.T) {
 	})
 }
 
-func TestWithDelay(t *testing.T) {
-	t.Run("delay is set successfully", func(t *testing.T) {
+func TestWithSecretKey(t *testing.T) {
+	t.Run("SecretKey is set successfully", func(t *testing.T) {
 		// Setup
 		t.Parallel()
 
 		// Arrange
 		config := defaultClientConfig()
-		delay := 1
+		key := "secret-key123"
 
 		// Act
-		WithDelay(delay).apply(config)
+		WithSecretKey(key).apply(config)
 
 		// Assert
-		assert.Equal(t, delay, config.delay)
-	})
-
-	t.Run("delay is not set when value < 0", func(t *testing.T) {
-		// Setup
-		t.Parallel()
-
-		// Arrange
-		config := defaultClientConfig()
-		delay := -1
-
-		// Act
-		WithDelay(delay).apply(config)
-
-		// Assert
-		assert.Equal(t, 0, config.delay)
+		assert.Equal(t, key, config.secretKey)
 	})
 }

contact.go

@@ -0,0 +1,53 @@
+package client
+
+import "time"
+
+// Contact represents a contact object in the system
+type Contact struct {
+	ID         string         `json:"id"`
+	Email      string         `json:"email"`
+	Subscribed bool           `json:"subscribed"`
+	Data       map[string]any `json:"data"`
+	CreatedAt  time.Time      `json:"createdAt"`
+	UpdatedAt  time.Time      `json:"updatedAt"`
+}
+
+// ContactCreateRequest represents the payload to create or update a contact
+type ContactCreateRequest struct {
+	Email      string         `json:"email"`
+	Subscribed bool           `json:"subscribed"`
+	Data       map[string]any `json:"data,omitempty"`
+}
+
+// ContactListRequest represents the payload to list contacts with optional filters
+type ContactListRequest struct {
+	Limit      *int    `json:"limit"`
+	Cursor     *string `json:"cursor"`
+	Subscribed *bool   `json:"subscribed"`
+	Search     *string `json:"search"`
+}
+
+// ContactCreateResponse represents the response from creating or updating a contact
+type ContactCreateResponse struct {
+	Success bool    `json:"success"`
+	Data    Contact `json:"data"`
+}
+
+// ContactDeleteResponse represents the response from deleting a contact
+type ContactDeleteResponse struct {
+	Success bool `json:"success"`
+	Data    struct {
+		Message string `json:"message"`
+	} `json:"data"`
+}
+
+// ContactListResponse represents the response from listing contacts
+type ContactListResponse struct {
+	Success bool `json:"success"`
+	Data    struct {
+		Items      []Contact `json:"items"`
+		NextCursor string    `json:"nextCursor"`
+		HasMore    bool      `json:"hasMore"`
+		Total      int       `json:"total"`
+	} `json:"data"`
+}