Merge pull request #16 from messagebird/resource-listing

Allows the client to list all resources

Author: Dirk Hoekstra

client.go

@@ -22,12 +22,27 @@ import (
 
 const (
 	// ClientVersion is used in User-Agent request header to provide server with API level.
-	ClientVersion = "4.1.0"
+	ClientVersion = "4.2.0"
 
 	// Endpoint points you to MessageBird REST API.
 	Endpoint = "https://rest.messagebird.com"
 )
 
+const (
+	// HLRPath represents the path to the HLR resource.
+	HLRPath = "hlr"
+	// MessagePath represents the path to the Message resource.
+	MessagePath = "messages"
+	// MMSPath represents the path to the MMS resource.
+	MMSPath = "mms"
+	// VoiceMessagePath represents the path to the VoiceMessage resource.
+	VoiceMessagePath = "voicemessages"
+	// VerifyPath represents the path to the Verify resource.
+	VerifyPath = "verify"
+	// LookupPath represents the path to the Lookup resource.
+	LookupPath = "lookup"
+)
+
 var (
 	// ErrResponse is returned when we were able to contact API but request was not successful and contains error details.
 	ErrResponse = errors.New("The MessageBird API returned an error")
@@ -140,7 +155,7 @@ func (c *Client) Balance() (*Balance, error) {
 // created by the NewHLR function.
 func (c *Client) HLR(id string) (*HLR, error) {
 	hlr := &HLR{}
-	if err := c.request(hlr, "hlr/"+id, nil); err != nil {
+	if err := c.request(hlr, HLRPath+"/"+id, nil); err != nil {
 		if err == ErrResponse {
 			return hlr, err
 		}
@@ -151,6 +166,21 @@ func (c *Client) HLR(id string) (*HLR, error) {
 	return hlr, nil
 }
 
+// HLRs lists all HLR objects that were previously created by the NewHLR
+// function.
+func (c *Client) HLRs() (*HLRList, error) {
+	hlrList := &HLRList{}
+	if err := c.request(hlrList, HLRPath, nil); err != nil {
+		if err == ErrResponse {
+			return hlrList, err
+		}
+
+		return nil, err
+	}
+
+	return hlrList, nil
+}
+
 // NewHLR retrieves the information of an existing HLR.
 func (c *Client) NewHLR(msisdn, reference string) (*HLR, error) {
 	params := &url.Values{
@@ -159,7 +189,7 @@ func (c *Client) NewHLR(msisdn, reference string) (*HLR, error) {
 	}
 
 	hlr := &HLR{}
-	if err := c.request(hlr, "hlr", params); err != nil {
+	if err := c.request(hlr, HLRPath, params); err != nil {
 		if err == ErrResponse {
 			return hlr, err
 		}
@@ -173,7 +203,7 @@ func (c *Client) NewHLR(msisdn, reference string) (*HLR, error) {
 // Message retrieves the information of an existing Message.
 func (c *Client) Message(id string) (*Message, error) {
 	message := &Message{}
-	if err := c.request(message, "messages/"+id, nil); err != nil {
+	if err := c.request(message, MessagePath+"/"+id, nil); err != nil {
 		if err == ErrResponse {
 			return message, err
 		}
@@ -184,6 +214,25 @@ func (c *Client) Message(id string) (*Message, error) {
 	return message, nil
 }
 
+// Messages retrieves all messages of the user represented as a MessageList object.
+func (c *Client) Messages(msgListParams *MessageListParams) (*MessageList, error) {
+	messageList := &MessageList{}
+	params, err := paramsForMessageList(msgListParams)
+	if err != nil {
+		return messageList, err
+	}
+
+	if err := c.request(messageList, MessagePath+"?"+params.Encode(), nil); err != nil {
+		if err == ErrResponse {
+			return messageList, err
+		}
+
+		return nil, err
+	}
+
+	return messageList, nil
+}
+
 // NewMessage creates a new message for one or more recipients.
 func (c *Client) NewMessage(originator string, recipients []string, body string, msgParams *MessageParams) (*Message, error) {
 	params, err := paramsForMessage(msgParams)
@@ -196,7 +245,7 @@ func (c *Client) NewMessage(originator string, recipients []string, body string,
 	params.Set("recipients", strings.Join(recipients, ","))
 
 	message := &Message{}
-	if err := c.request(message, "messages", params); err != nil {
+	if err := c.request(message, MessagePath, params); err != nil {
 		if err == ErrResponse {
 			return message, err
 		}
@@ -210,7 +259,7 @@ func (c *Client) NewMessage(originator string, recipients []string, body string,
 // MMSMessage retrieves the information of an existing MmsMessage.
 func (c *Client) MMSMessage(id string) (*MMSMessage, error) {
 	mmsMessage := &MMSMessage{}
-	if err := c.request(mmsMessage, "mms/"+id, nil); err != nil {
+	if err := c.request(mmsMessage, MMSPath+"/"+id, nil); err != nil {
 		if err == ErrResponse {
 			return mmsMessage, err
 		}
@@ -232,7 +281,7 @@ func (c *Client) NewMMSMessage(originator string, recipients []string, msgParams
 	params.Set("recipients", strings.Join(recipients, ","))
 
 	mmsMessage := &MMSMessage{}
-	if err := c.request(mmsMessage, "mms", params); err != nil {
+	if err := c.request(mmsMessage, MMSPath, params); err != nil {
 		if err == ErrResponse {
 			return mmsMessage, err
 		}
@@ -246,7 +295,7 @@ func (c *Client) NewMMSMessage(originator string, recipients []string, msgParams
 // VoiceMessage retrieves the information of an existing VoiceMessage.
 func (c *Client) VoiceMessage(id string) (*VoiceMessage, error) {
 	message := &VoiceMessage{}
-	if err := c.request(message, "voicemessages/"+id, nil); err != nil {
+	if err := c.request(message, VoiceMessagePath+"/"+id, nil); err != nil {
 		if err == ErrResponse {
 			return message, err
 		}
@@ -257,14 +306,28 @@ func (c *Client) VoiceMessage(id string) (*VoiceMessage, error) {
 	return message, nil
 }
 
+// VoiceMessages retrieves all VoiceMessages of the user.
+func (c *Client) VoiceMessages() (*VoiceMessageList, error) {
+	messageList := &VoiceMessageList{}
+	if err := c.request(messageList, VoiceMessagePath, nil); err != nil {
+		if err == ErrResponse {
+			return messageList, err
+		}
+
+		return nil, err
+	}
+
+	return messageList, nil
+}
+
 // NewVoiceMessage creates a new voice message for one or more recipients.
 func (c *Client) NewVoiceMessage(recipients []string, body string, params *VoiceMessageParams) (*VoiceMessage, error) {
 	urlParams := paramsForVoiceMessage(params)
 	urlParams.Set("body", body)
 	urlParams.Set("recipients", strings.Join(recipients, ","))
 
 	message := &VoiceMessage{}
-	if err := c.request(message, "voicemessages", urlParams); err != nil {
+	if err := c.request(message, VoiceMessagePath, urlParams); err != nil {
 		if err == ErrResponse {
 			return message, err
 		}
@@ -281,7 +344,7 @@ func (c *Client) NewVerify(recipient string, params *VerifyParams) (*Verify, err
 	urlParams.Set("recipient", recipient)
 
 	verify := &Verify{}
-	if err := c.request(verify, "verify", urlParams); err != nil {
+	if err := c.request(verify, VerifyPath, urlParams); err != nil {
 		if err == ErrResponse {
 			return verify, err
 		}
@@ -297,7 +360,7 @@ func (c *Client) VerifyToken(id, token string) (*Verify, error) {
 	params := &url.Values{}
 	params.Set("token", token)
 
-	path := "verify/" + id + "?" + params.Encode()
+	path := VerifyPath + "/" + id + "?" + params.Encode()
 
 	verify := &Verify{}
 	if err := c.request(verify, path, nil); err != nil {
@@ -314,7 +377,7 @@ func (c *Client) VerifyToken(id, token string) (*Verify, error) {
 // Lookup performs a new lookup for the specified number.
 func (c *Client) Lookup(phoneNumber string, params *LookupParams) (*Lookup, error) {
 	urlParams := paramsForLookup(params)
-	path := "lookup/" + phoneNumber + "?" + urlParams.Encode()
+	path := LookupPath + "/" + phoneNumber + "?" + urlParams.Encode()
 
 	lookup := &Lookup{}
 	if err := c.request(lookup, path, nil); err != nil {
@@ -331,7 +394,7 @@ func (c *Client) Lookup(phoneNumber string, params *LookupParams) (*Lookup, erro
 // NewLookupHLR creates a new HLR lookup for the specified number.
 func (c *Client) NewLookupHLR(phoneNumber string, params *LookupParams) (*HLR, error) {
 	urlParams := paramsForLookup(params)
-	path := "lookup/" + phoneNumber + "/hlr"
+	path := LookupPath + "/" + phoneNumber + "/" + HLRPath
 
 	hlr := &HLR{}
 	if err := c.request(hlr, path, urlParams); err != nil {
@@ -348,7 +411,7 @@ func (c *Client) NewLookupHLR(phoneNumber string, params *LookupParams) (*HLR, e
 // LookupHLR performs a HLR lookup for the specified number.
 func (c *Client) LookupHLR(phoneNumber string, params *LookupParams) (*HLR, error) {
 	urlParams := paramsForLookup(params)
-	path := "lookup/" + phoneNumber + "/hlr?" + urlParams.Encode()
+	path := LookupPath + "/" + phoneNumber + "/" + HLRPath + "?" + urlParams.Encode()
 
 	hlr := &HLR{}
 	if err := c.request(hlr, path, nil); err != nil {

hlr.go

@@ -16,3 +16,13 @@ type HLR struct {
 	StatusDatetime  *time.Time
 	Errors          []Error
 }
+
+// HLRList represents a list of HLR requests.
+type HLRList struct {
+	Offset     int
+	Limit      int
+	Count      int
+	TotalCount int
+	Links      map[string]*string
+	Items      []HLR
+}

hlr_test.go

@@ -1,13 +1,14 @@
 package messagebird
 
 import (
+	"net/http"
 	"testing"
 	"time"
 )
 
 var hlrObject = []byte(`{
   "id":"27978c50354a93ca0ca8de6h54340177",
-  "href":"https:\/\/rest.messagebird.com\/hlr\/27978c50354a93ca0ca8de6h54340177",
+  "href":"https://rest.messagebird.com/hlr/27978c50354a93ca0ca8de6h54340177",
   "msisdn":31612345678,
   "network":20406,
   "reference":"MyReference",
@@ -16,42 +17,77 @@ var hlrObject = []byte(`{
   "statusDatetime":"2015-01-04T13:14:09+00:00"
 }`)
 
+var hlrListObject = []byte(`{
+  "offset":0,
+  "limit":20,
+  "count":2,
+  "totalCount":2,
+  "links":{
+    "first":"https://rest.messagebird.com/hlr/?offset=0",
+    "previous":null,
+    "next":null,
+    "last":"https://rest.messagebird.com/hlr/?offset=0"
+  },
+  "items":[
+    {
+      "id":"27978c50354a93ca0ca8de6h54340177",
+      "href":"https://rest.messagebird.com/hlr/27978c50354a93ca0ca8de6h54340177",
+      "msisdn":31612345678,
+      "network":20406,
+      "reference":"MyReference",
+      "status":"sent",
+      "createdDatetime":"2015-01-04T13:14:08+00:00",
+      "statusDatetime":"2015-01-04T13:14:09+00:00"
+    },
+    {
+      "id":"27978c50354a93ca0ca8de6h54340177",
+      "href":"https://rest.messagebird.com/hlr/27978c50354a93ca0ca8de6h54340177",
+      "msisdn":31612345678,
+      "network":20406,
+      "reference":"MyReference",
+      "status":"sent",
+      "createdDatetime":"2015-01-04T13:14:08+00:00",
+      "statusDatetime":"2015-01-04T13:14:09+00:00"
+    }
+  ]
+}`)
+
 func assertHLRObject(t *testing.T, hlr *HLR) {
 	if hlr.ID != "27978c50354a93ca0ca8de6h54340177" {
-		t.Errorf("Unexpected result for HLR Id: %s", hlr.ID)
+		t.Errorf("Unexpected result for HLR Id: %s, expected: 27978c50354a93ca0ca8de6h54340177", hlr.ID)
 	}
 
 	if hlr.HRef != "https://rest.messagebird.com/hlr/27978c50354a93ca0ca8de6h54340177" {
-		t.Errorf("Unexpected HLR href: %s", hlr.HRef)
+		t.Errorf("Unexpected HLR href: %s, expected: https://rest.messagebird.com/hlr/27978c50354a93ca0ca8de6h54340177", hlr.HRef)
 	}
 
 	if hlr.MSISDN != 31612345678 {
-		t.Errorf("Unexpected HLR msisdn: %d", hlr.MSISDN)
+		t.Errorf("Unexpected HLR msisdn: %d, expected: 31612345678", hlr.MSISDN)
 	}
 
 	if hlr.Network != 20406 {
-		t.Errorf("Unexpected HLR network: %d", hlr.Network)
+		t.Errorf("Unexpected HLR network: %d, expected: 20406", hlr.Network)
 	}
 
 	if hlr.Reference != "MyReference" {
-		t.Errorf("Unexpected HLR reference: %s", hlr.Reference)
+		t.Errorf("Unexpected HLR reference: %s, expected: MyReference", hlr.Reference)
 	}
 
 	if hlr.Status != "sent" {
-		t.Errorf("Unexpected HLR status: %s", hlr.Status)
+		t.Errorf("Unexpected HLR status: %s, expected: sent", hlr.Status)
 	}
 
 	if hlr.CreatedDatetime == nil || hlr.CreatedDatetime.Format(time.RFC3339) != "2015-01-04T13:14:08Z" {
-		t.Errorf("Unexpected HLR created datetime: %s", hlr.CreatedDatetime.Format(time.RFC3339))
+		t.Errorf("Unexpected HLR created datetime: %s, expected: 2015-01-04T13:14:08Z", hlr.CreatedDatetime.Format(time.RFC3339))
 	}
 
 	if hlr.StatusDatetime == nil || hlr.StatusDatetime.Format(time.RFC3339) != "2015-01-04T13:14:09Z" {
-		t.Errorf("Unexpected HLR status datetime: %s", hlr.StatusDatetime.Format(time.RFC3339))
+		t.Errorf("Unexpected HLR status datetime: %s, expected: 2015-01-04T13:14:09Z", hlr.StatusDatetime.Format(time.RFC3339))
 	}
 }
 
 func TestHLR(t *testing.T) {
-	SetServerResponse(200, hlrObject)
+	SetServerResponse(http.StatusOK, hlrObject)
 
 	hlr, err := mbClient.HLR("27978c50354a93ca0ca8de6h54340177")
 	if err != nil {
@@ -62,7 +98,7 @@ func TestHLR(t *testing.T) {
 }
 
 func TestNewHLR(t *testing.T) {
-	SetServerResponse(200, hlrObject)
+	SetServerResponse(http.StatusOK, hlrObject)
 
 	hlr, err := mbClient.NewHLR("31612345678", "MyReference")
 	if err != nil {
@@ -73,22 +109,48 @@ func TestNewHLR(t *testing.T) {
 }
 
 func TestHLRError(t *testing.T) {
-	SetServerResponse(405, accessKeyErrorObject)
+	SetServerResponse(http.StatusMethodNotAllowed, accessKeyErrorObject)
 
 	hlr, err := mbClient.HLR("dummy_hlr_id")
 	if err != ErrResponse {
 		t.Fatalf("Expected ErrResponse to be returned, instead I got %s", err)
 	}
 
 	if len(hlr.Errors) != 1 {
-		t.Fatalf("Unexpected number of errors: %d", len(hlr.Errors))
+		t.Fatalf("Unexpected number of errors: %d, expected: 1", len(hlr.Errors))
 	}
 
 	if hlr.Errors[0].Code != 2 {
-		t.Errorf("Unexpected error code: %d", hlr.Errors[0].Code)
+		t.Errorf("Unexpected error code: %d, expected: 2", hlr.Errors[0].Code)
 	}
 
 	if hlr.Errors[0].Parameter != "access_key" {
-		t.Errorf("Unexpected error parameter: %s", hlr.Errors[0].Parameter)
+		t.Errorf("Unexpected error parameter: %s, expected: access_key", hlr.Errors[0].Parameter)
+	}
+}
+
+func TestHLRList(t *testing.T) {
+	SetServerResponse(http.StatusOK, hlrListObject)
+
+	hlrList, err := mbClient.HLRs()
+	if err != nil {
+		t.Fatalf("Didn't expect an error while requesting HLRs: %s", err)
+	}
+
+	if hlrList.Offset != 0 {
+		t.Errorf("Unexpected result for the HLRList offset: %d, expected: 0", hlrList.Offset)
+	}
+	if hlrList.Limit != 20 {
+		t.Errorf("Unexpected result for the HLRList limit: %d, expected: 20", hlrList.Limit)
+	}
+	if hlrList.Count != 2 {
+		t.Errorf("Unexpected result for the HLRList count: %d, expected: 2", hlrList.Count)
+	}
+	if hlrList.TotalCount != 2 {
+		t.Errorf("Unexpected result for the HLRList total count: %d, expected: 2", hlrList.TotalCount)
+	}
+
+	for _, hlr := range hlrList.Items {
+		assertHLRObject(t, &hlr)
 	}
 }