Merge branch 'add-contacts' into v5_staging

Author: epels

balance/balance_test.go

@@ -5,7 +5,7 @@ import (
 	"testing"
 
 	messagebird "github.com/messagebird/go-rest-api"
-	"github.com/messagebird/go-rest-api/internal/messagebirdtest"
+	"github.com/messagebird/go-rest-api/internal/mbtest"
 )
 
 const Epsilon float32 = 0.001
@@ -15,12 +15,12 @@ func cmpFloat32(a, b float32) bool {
 }
 
 func TestMain(m *testing.M) {
-	messagebirdtest.EnableServer(m)
+	mbtest.EnableServer(m)
 }
 
 func TestRead(t *testing.T) {
-	messagebirdtest.WillReturnTestdata(t, "balance.json", http.StatusOK)
-	client := messagebirdtest.Client(t)
+	mbtest.WillReturnTestdata(t, "balance.json", http.StatusOK)
+	client := mbtest.Client(t)
 
 	balance, err := Read(client)
 	if err != nil {
@@ -41,8 +41,8 @@ func TestRead(t *testing.T) {
 }
 
 func TestReadError(t *testing.T) {
-	messagebirdtest.WillReturnAccessKeyError()
-	client := messagebirdtest.Client(t)
+	mbtest.WillReturnAccessKeyError()
+	client := mbtest.Client(t)
 
 	_, err := Read(client)
 

client.go

@@ -109,25 +109,30 @@ func (c *Client) Request(v interface{}, method, path string, data interface{}) e
 		c.DebugLog.Printf("HTTP RESPONSE: %s", string(responseBody))
 	}
 
-	// Status code 500 is a server error and means nothing can be done at this
-	// point.
-	if response.StatusCode == 500 {
-		return ErrUnexpectedResponse
-	}
-	// Status codes 200 and 201 are indicative of being able to convert the
-	// response body to the struct that was specified.
-	if response.StatusCode == 200 || response.StatusCode == 201 {
+	switch response.StatusCode {
+	case http.StatusOK, http.StatusCreated:
+		// Status codes 200 and 201 are indicative of being able to convert the
+		// response body to the struct that was specified.
 		if err := json.Unmarshal(responseBody, &v); err != nil {
 			return fmt.Errorf("could not decode response JSON, %s: %v", string(responseBody), err)
 		}
+
 		return nil
-	}
+	case http.StatusNoContent:
+		// Status code 204 is returned for successful DELETE requests. Don't try to
+		// unmarshal the body: that would return errors.
+		return nil
+	case http.StatusInternalServerError:
+		// Status code 500 is a server error and means nothing can be done at this
+		// point.
+		return ErrUnexpectedResponse
+	default:
+		// Anything else than a 200/201/204/500 should be a JSON error.
+		var errorResponse ErrorResponse
+		if err := json.Unmarshal(responseBody, &errorResponse); err != nil {
+			return err
+		}
 
-	// Anything else than a 200/201/500 should be a JSON error.
-	var errorResponse ErrorResponse
-	if err := json.Unmarshal(responseBody, &errorResponse); err != nil {
-		return err
+		return errorResponse
 	}
-
-	return errorResponse
 }

contact/contact.go

@@ -0,0 +1,154 @@
+package contact
+
+import (
+	"errors"
+	"fmt"
+	"net/http"
+	"net/url"
+	"strconv"
+	"time"
+
+	messagebird "github.com/messagebird/go-rest-api"
+)
+
+// Contact gets returned by the API.
+type Contact struct {
+	ID            string
+	HRef          string
+	MSISDN        int64
+	FirstName     string
+	LastName      string
+	CustomDetails struct {
+		Custom1 string
+		Custom2 string
+		Custom3 string
+		Custom4 string
+	}
+	Groups struct {
+		TotalCount int
+		HRef       string
+	}
+	Messages struct {
+		TotalCount int
+		HRef       string
+	}
+	CreatedDatetime time.Time
+	UpdatedDatetime time.Time
+}
+
+type ContactList struct {
+	Limit, Offset     int
+	Count, TotalCount int
+	Items             []Contact
+}
+
+// ListOptions can be used to set pagination options in List().
+type ListOptions struct {
+	Limit, Offset int
+}
+
+// Request represents a contact for write operations, e.g. for creating a new
+// contact or updating an existing one.
+type Request struct {
+	MSISDN    string `json:"msisdn,omitempty"`
+	FirstName string `json:"firstName,omitempty"`
+	LastName  string `json:"lastName,omitempty"`
+	Custom1   string `json:"custom1,omitempty"`
+	Custom2   string `json:"custom2,omitempty"`
+	Custom3   string `json:"custom3,omitempty"`
+	Custom4   string `json:"custom4,omitempty"`
+}
+
+// path represents the path to the Contacts resource.
+const path = "contacts"
+
+// DefaultListOptions provides reasonable values for List().
+var DefaultListOptions = &ListOptions{
+	Limit:  20,
+	Offset: 0,
+}
+
+func Create(c *messagebird.Client, contactRequest *Request) (*Contact, error) {
+	if err := validateCreate(contactRequest); err != nil {
+		return nil, err
+	}
+
+	contact := &Contact{}
+	if err := c.Request(contact, http.MethodPost, path, contactRequest); err != nil {
+		return nil, err
+	}
+
+	return contact, nil
+}
+
+func validateCreate(contactRequest *Request) error {
+	if contactRequest.MSISDN == "" {
+		return errors.New("msisdn is required")
+	}
+
+	return nil
+}
+
+// Delete attempts deleting the contact with the provided ID. If nil is returned,
+// the resource was deleted successfully.
+func Delete(c *messagebird.Client, id string) error {
+	if id == "" {
+		return errors.New("id is required")
+	}
+
+	return c.Request(nil, http.MethodDelete, path+"/"+id, nil)
+}
+
+// List retrieves a paginated list of contacts, based on the options provided.
+// It's worth noting DefaultListOptions.
+func List(c *messagebird.Client, options *ListOptions) (*ContactList, error) {
+	query, err := listQuery(options)
+	if err != nil {
+		return nil, err
+	}
+
+	contactList := &ContactList{}
+	if err = c.Request(contactList, http.MethodGet, path+"?"+query, nil); err != nil {
+		return nil, err
+	}
+
+	return contactList, nil
+}
+
+func listQuery(options *ListOptions) (string, error) {
+	if options.Limit < 10 {
+		return "", fmt.Errorf("minimum limit is 10, got %d", options.Limit)
+	}
+
+	if options.Offset < 0 {
+		return "", fmt.Errorf("offset can not be negative")
+	}
+
+	values := &url.Values{}
+
+	values.Set("limit", strconv.Itoa(options.Limit))
+	values.Set("offset", strconv.Itoa(options.Offset))
+
+	return values.Encode(), nil
+}
+
+// Read retrieves the information of an existing contact.
+func Read(c *messagebird.Client, id string) (*Contact, error) {
+	contact := &Contact{}
+	if err := c.Request(contact, http.MethodGet, path+"/"+id, nil); err != nil {
+		return nil, err
+	}
+
+	return contact, nil
+}
+
+// Update updates the record referenced by id with any values set in contactRequest.
+// Do not set any values that should not be updated.
+func Update(c *messagebird.Client, id string, contactRequest *Request) (*Contact, error) {
+	contact := &Contact{}
+	if err := c.Request(contact, http.MethodPatch, path+"/"+id, contactRequest); err != nil {
+		return nil, err
+	}
+
+	return contact, nil
+}