Add convenience methods to rest/client types

rest/client/apiv1_client.go

@@ -1,3 +1,4 @@
+// Package client provides a basic REST client for Inbucket
 package client
 
 import (
@@ -10,19 +11,19 @@ import (
 	"github.com/jhillyerd/inbucket/rest/model"
 )
 
-// ClientV1 accesses the Inbucket REST API v1
-type ClientV1 struct {
+// Client accesses the Inbucket REST API v1
+type Client struct {
 	restClient
 }
 
-// NewV1 creates a new v1 REST API client given the base URL of an Inbucket server, ex:
+// New creates a new v1 REST API client given the base URL of an Inbucket server, ex:
 // "http://localhost:9000"
-func NewV1(baseURL string) (*ClientV1, error) {
+func New(baseURL string) (*Client, error) {
 	parsedURL, err := url.Parse(baseURL)
 	if err != nil {
 		return nil, err
 	}
-	c := &ClientV1{
+	c := &Client{
 		restClient{
 			client: &http.Client{
 				Timeout: 30 * time.Second,
@@ -34,21 +35,31 @@ func NewV1(baseURL string) (*ClientV1, error) {
 }
 
 // ListMailbox returns a list of messages for the requested mailbox
-func (c *ClientV1) ListMailbox(name string) (headers []*model.JSONMessageHeaderV1, err error) {
+func (c *Client) ListMailbox(name string) (headers []*MessageHeader, err error) {
 	uri := "/api/v1/mailbox/" + url.QueryEscape(name)
 	err = c.doJSON("GET", uri, &headers)
+	if err != nil {
+		return nil, err
+	}
+	for _, h := range headers {
+		h.client = c
+	}
 	return
 }
 
 // GetMessage returns the message details given a mailbox name and message ID.
-func (c *ClientV1) GetMessage(name, id string) (message *model.JSONMessageV1, err error) {
+func (c *Client) GetMessage(name, id string) (message *Message, err error) {
 	uri := "/api/v1/mailbox/" + url.QueryEscape(name) + "/" + id
 	err = c.doJSON("GET", uri, &message)
+	if err != nil {
+		return nil, err
+	}
+	message.client = c
 	return
 }
 
 // GetMessageSource returns the message source given a mailbox name and message ID.
-func (c *ClientV1) GetMessageSource(name, id string) (*bytes.Buffer, error) {
+func (c *Client) GetMessageSource(name, id string) (*bytes.Buffer, error) {
 	uri := "/api/v1/mailbox/" + url.QueryEscape(name) + "/" + id + "/source"
 	resp, err := c.do("GET", uri)
 	if err != nil {
@@ -68,7 +79,7 @@ func (c *ClientV1) GetMessageSource(name, id string) (*bytes.Buffer, error) {
 }
 
 // DeleteMessage deletes a single message given the mailbox name and message ID.
-func (c *ClientV1) DeleteMessage(name, id string) error {
+func (c *Client) DeleteMessage(name, id string) error {
 	uri := "/api/v1/mailbox/" + url.QueryEscape(name) + "/" + id
 	resp, err := c.do("DELETE", uri)
 	if err != nil {
@@ -82,7 +93,7 @@ func (c *ClientV1) DeleteMessage(name, id string) error {
 }
 
 // PurgeMailbox deletes all messages in the given mailbox
-func (c *ClientV1) PurgeMailbox(name string) error {
+func (c *Client) PurgeMailbox(name string) error {
 	uri := "/api/v1/mailbox/" + url.QueryEscape(name)
 	resp, err := c.do("DELETE", uri)
 	if err != nil {
@@ -94,3 +105,40 @@ func (c *ClientV1) PurgeMailbox(name string) error {
 	}
 	return nil
 }
+
+// MessageHeader represents an Inbucket message sans content
+type MessageHeader struct {
+	*model.JSONMessageHeaderV1
+	client *Client
+}
+
+// GetMessage returns this message with content
+func (h *MessageHeader) GetMessage() (message *Message, err error) {
+	return h.client.GetMessage(h.Mailbox, h.ID)
+}
+
+// GetSource returns the source for this message
+func (h *MessageHeader) GetSource() (*bytes.Buffer, error) {
+	return h.client.GetMessageSource(h.Mailbox, h.ID)
+}
+
+// Delete deletes this message from the mailbox
+func (h *MessageHeader) Delete() error {
+	return h.client.DeleteMessage(h.Mailbox, h.ID)
+}
+
+// Message represents an Inbucket message including content
+type Message struct {
+	*model.JSONMessageV1
+	client *Client
+}
+
+// GetSource returns the source for this message
+func (m *Message) GetSource() (*bytes.Buffer, error) {
+	return m.client.GetMessageSource(m.Mailbox, m.ID)
+}
+
+// Delete deletes this message from the mailbox
+func (m *Message) Delete() error {
+	return m.client.DeleteMessage(m.Mailbox, m.ID)
+}