Complete REST client for #43

- Add source, delete and purge

CHANGELOG.md

@@ -11,6 +11,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Storage of To: header in messages (likely breaks existing datastores)
 - Attachment list to [GET message
   JSON](https://github.com/jhillyerd/inbucket/wiki/REST-GET-message)
+- Go client for REST API
 
 ### Fixed
 - No longer run out of file handles when dealing with a large number of

rest/client/apiv1_client.go

@@ -1,8 +1,11 @@
 package client
 
 import (
+	"bytes"
+	"fmt"
 	"net/http"
 	"net/url"
+	"time"
 
 	"github.com/jhillyerd/inbucket/rest/model"
 )
@@ -21,7 +24,9 @@ func NewV1(baseURL string) (*ClientV1, error) {
 	}
 	c := &ClientV1{
 		restClient{
-			client:  &http.Client{},
+			client: &http.Client{
+				Timeout: 30 * time.Second,
+			},
 			baseURL: parsedURL,
 		},
 	}
@@ -31,13 +36,61 @@ 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) {
 	uri := "/api/v1/mailbox/" + url.QueryEscape(name)
-	err = c.doGet(uri, &headers)
+	err = c.doJSON("GET", uri, &headers)
 	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) {
 	uri := "/api/v1/mailbox/" + url.QueryEscape(name) + "/" + id
-	err = c.doGet(uri, &message)
+	err = c.doJSON("GET", uri, &message)
 	return
 }
+
+// GetMessageSource returns the message source given a mailbox name and message ID.
+func (c *ClientV1) 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 {
+		return nil, err
+	}
+
+	defer func() {
+		_ = resp.Body.Close()
+	}()
+	if resp.StatusCode != http.StatusOK {
+		return nil,
+			fmt.Errorf("Unexpected HTTP response status %v: %s", resp.StatusCode, resp.Status)
+	}
+	buf := new(bytes.Buffer)
+	_, err = buf.ReadFrom(resp.Body)
+	return buf, err
+}
+
+// DeleteMessage deletes a single message given the mailbox name and message ID.
+func (c *ClientV1) DeleteMessage(name, id string) error {
+	uri := "/api/v1/mailbox/" + url.QueryEscape(name) + "/" + id
+	resp, err := c.do("DELETE", uri)
+	if err != nil {
+		return err
+	}
+	_ = resp.Body.Close()
+	if resp.StatusCode != http.StatusOK {
+		return fmt.Errorf("Unexpected HTTP response status %v: %s", resp.StatusCode, resp.Status)
+	}
+	return nil
+}
+
+// PurgeMailbox deletes all messages in the given mailbox
+func (c *ClientV1) PurgeMailbox(name string) error {
+	uri := "/api/v1/mailbox/" + url.QueryEscape(name)
+	resp, err := c.do("DELETE", uri)
+	if err != nil {
+		return err
+	}
+	_ = resp.Body.Close()
+	if resp.StatusCode != http.StatusOK {
+		return fmt.Errorf("Unexpected HTTP response status %v: %s", resp.StatusCode, resp.Status)
+	}
+	return nil
+}

rest/client/apiv1_client_test.go

@@ -53,3 +53,93 @@ func TestClientV1GetMessage(t *testing.T) {
 		t.Errorf("req.URL == %q, want %q", got, want)
 	}
 }
+
+func TestClientV1GetMessageSource(t *testing.T) {
+	var want, got string
+
+	c, err := NewV1(baseURLStr)
+	if err != nil {
+		t.Fatal(err)
+	}
+	mth := &mockHTTPClient{
+		statusCode: 200,
+		body:       "message source",
+	}
+	c.client = mth
+
+	// Method under test
+	source, err := c.GetMessageSource("testbox", "20170107T224128-0000")
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	want = "GET"
+	got = mth.req.Method
+	if got != want {
+		t.Errorf("req.Method == %q, want %q", got, want)
+	}
+
+	want = baseURLStr + "/api/v1/mailbox/testbox/20170107T224128-0000/source"
+	got = mth.req.URL.String()
+	if got != want {
+		t.Errorf("req.URL == %q, want %q", got, want)
+	}
+
+	want = "message source"
+	got = source.String()
+	if got != want {
+		t.Errorf("Source == %q, want: %q", got, want)
+	}
+}
+
+func TestClientV1DeleteMessage(t *testing.T) {
+	var want, got string
+
+	c, err := NewV1(baseURLStr)
+	if err != nil {
+		t.Fatal(err)
+	}
+	mth := &mockHTTPClient{}
+	c.client = mth
+
+	// Method under test
+	c.DeleteMessage("testbox", "20170107T224128-0000")
+
+	want = "DELETE"
+	got = mth.req.Method
+	if got != want {
+		t.Errorf("req.Method == %q, want %q", got, want)
+	}
+
+	want = baseURLStr + "/api/v1/mailbox/testbox/20170107T224128-0000"
+	got = mth.req.URL.String()
+	if got != want {
+		t.Errorf("req.URL == %q, want %q", got, want)
+	}
+}
+
+func TestClientV1PurgeMailbox(t *testing.T) {
+	var want, got string
+
+	c, err := NewV1(baseURLStr)
+	if err != nil {
+		t.Fatal(err)
+	}
+	mth := &mockHTTPClient{}
+	c.client = mth
+
+	// Method under test
+	c.PurgeMailbox("testbox")
+
+	want = "DELETE"
+	got = mth.req.Method
+	if got != want {
+		t.Errorf("req.Method == %q, want %q", got, want)
+	}
+
+	want = baseURLStr + "/api/v1/mailbox/testbox"
+	got = mth.req.URL.String()
+	if got != want {
+		t.Errorf("req.URL == %q, want %q", got, want)
+	}
+}

rest/client/rest.go

@@ -37,9 +37,9 @@ func (c *restClient) do(method, uri string) (*http.Response, error) {
 	return c.client.Do(req)
 }
 
-// doGet performs a GET request with this client and marshalls the JSON response into v
-func (c *restClient) doGet(uri string, v interface{}) error {
-	resp, err := c.do("GET", uri)
+// doGet performs an HTTP request with this client and marshalls the JSON response into v
+func (c *restClient) doJSON(method string, uri string, v interface{}) error {
+	resp, err := c.do(method, uri)
 	if err != nil {
 		return err
 	}
@@ -48,8 +48,12 @@ func (c *restClient) doGet(uri string, v interface{}) error {
 		_ = resp.Body.Close()
 	}()
 	if resp.StatusCode == http.StatusOK {
-		// Decode response body
-		return json.NewDecoder(resp.Body).Decode(v)
+		if v == nil {
+			return nil
+		} else {
+			// Decode response body
+			return json.NewDecoder(resp.Body).Decode(v)
+		}
 	}
 
 	return fmt.Errorf("Unexpected HTTP response status %v: %s", resp.StatusCode, resp.Status)

rest/client/rest_test.go

@@ -21,13 +21,16 @@ func init() {
 }
 
 type mockHTTPClient struct {
-	req *http.Request
+	req        *http.Request
+	statusCode int
+	body       string
 }
 
 func (m *mockHTTPClient) Do(req *http.Request) (resp *http.Response, err error) {
 	m.req = req
 	resp = &http.Response{
-		Body: ioutil.NopCloser(&bytes.Buffer{}),
+		StatusCode: m.statusCode,
+		Body:       ioutil.NopCloser(bytes.NewBufferString(m.body)),
 	}
 
 	return
@@ -39,7 +42,10 @@ func TestDo(t *testing.T) {
 	mth := &mockHTTPClient{}
 	c := &restClient{mth, baseURL}
 
-	c.do("POST", "/dopost")
+	_, err := c.do("POST", "/dopost")
+	if err != nil {
+		t.Fatal(err)
+	}
 
 	want = "POST"
 	got = mth.req.Method
@@ -54,14 +60,51 @@ func TestDo(t *testing.T) {
 	}
 }
 
-func TestDoGet(t *testing.T) {
+func TestDoJSON(t *testing.T) {
 	var want, got string
 
-	mth := &mockHTTPClient{}
+	mth := &mockHTTPClient{
+		statusCode: 200,
+		body:       `{"foo": "bar"}`,
+	}
 	c := &restClient{mth, baseURL}
 
-	v := new(map[string]interface{})
-	c.doGet("/doget", &v)
+	var v map[string]interface{}
+	c.doJSON("GET", "/doget", &v)
+
+	want = "GET"
+	got = mth.req.Method
+	if got != want {
+		t.Errorf("req.Method == %q, want %q", got, want)
+	}
+
+	want = baseURLStr + "/doget"
+	got = mth.req.URL.String()
+	if got != want {
+		t.Errorf("req.URL == %q, want %q", got, want)
+	}
+
+	want = "bar"
+	if val, ok := v["foo"]; ok {
+		got = val.(string)
+		if got != want {
+			t.Errorf("map[foo] == %q, want: %q", got, want)
+		}
+	} else {
+		t.Errorf("Map did not contain key foo, want: %q", want)
+	}
+}
+
+func TestDoJSONNilV(t *testing.T) {
+	var want, got string
+
+	mth := &mockHTTPClient{statusCode: 200}
+	c := &restClient{mth, baseURL}
+
+	err := c.doJSON("GET", "/doget", nil)
+	if err != nil {
+		t.Fatal(err)
+	}
 
 	want = "GET"
 	got = mth.req.Method