Merge pull request #41 from messagebird/refactor-package

Refactor package

Author: epels

README.md

@@ -36,7 +36,7 @@ Now you can query the API for information or send data. For example, if we want
 
 ```go
 // Request the balance information, returned as a Balance object.
-balance, err := client.Balance()
+balance, err := balance.Read(client)
 if err != nil {
 	switch errResp := err.(type) {
 	case messagebird.ErrorResponse:

balance.go

@@ -0,0 +1,27 @@
+package balance
+
+import (
+	"net/http"
+
+	messagebird "github.com/messagebird/go-rest-api"
+)
+
+// Balance describes your balance information.
+type Balance struct {
+	Payment string
+	Type    string
+	Amount  float32
+}
+
+const path = "balance"
+
+// Read returns the balance information for the account that is associated with
+// the access key.
+func Read(c *messagebird.Client) (*Balance, error) {
+	balance := &Balance{}
+	if err := c.Request(balance, http.MethodGet, path, nil); err != nil {
+		return nil, err
+	}
+
+	return balance, nil
+}

balance/balance.go

@@ -1,43 +1,58 @@
-package messagebird
+package balance
 
-import "testing"
+import (
+	"net/http"
+	"testing"
+
+	messagebird "github.com/messagebird/go-rest-api"
+	"github.com/messagebird/go-rest-api/internal/messagebirdtest"
+)
 
 var balanceObject = []byte(`{
-  "payment":"prepaid",
-  "type":"credits",
-  "amount":9.2
-}`)
+  		"payment":"prepaid",
+  		"type":"credits",
+  		"amount":9.2
+	}`)
 
 const Epsilon float32 = 0.001
 
 func cmpFloat32(a, b float32) bool {
 	return (a-b) < Epsilon && (b-a) < Epsilon
 }
 
-func TestBalance(t *testing.T) {
-	SetServerResponse(200, balanceObject)
+func TestMain(m *testing.M) {
+	messagebirdtest.EnableServer(m)
+}
+
+func TestRead(t *testing.T) {
+	messagebirdtest.WillReturn(balanceObject, http.StatusOK)
+	client := messagebirdtest.Client(t)
 
-	balance, err := mbClient.Balance()
+	balance, err := Read(client)
 	if err != nil {
 		t.Fatalf("Didn't expect error while fetching the balance: %s", err)
 	}
 
 	if balance.Payment != "prepaid" {
 		t.Errorf("Unexpected balance payment: %s", balance.Payment)
 	}
+
 	if balance.Type != "credits" {
 		t.Errorf("Unexpected balance type: %s", balance.Type)
 	}
+
 	if !cmpFloat32(balance.Amount, 9.2) {
 		t.Errorf("Unexpected balance amount: %.2f", balance.Amount)
 	}
 }
 
-func TestBalanceError(t *testing.T) {
-	SetServerResponse(405, accessKeyErrorObject)
-	_, err := mbClient.Balance()
+func TestReadError(t *testing.T) {
+	messagebirdtest.WillReturnAccessKeyError()
+	client := messagebirdtest.Client(t)
+
+	_, err := Read(client)
 
-	errorResponse, ok := err.(ErrorResponse)
+	errorResponse, ok := err.(messagebird.ErrorResponse)
 	if !ok {
 		t.Fatalf("Expected ErrorResponse to be returned, instead I got %s", err)
 	}

balance_test.go renamed to balance/balance_test.go

@@ -34,21 +34,6 @@ const (
 	httpClientTimeout = 15 * time.Second
 )
 
-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 (
 	// ErrUnexpectedResponse is used when there was an internal server error and nothing can be done at this point.
 	ErrUnexpectedResponse = errors.New("The MessageBird API is currently unavailable")
@@ -146,224 +131,3 @@ func (c *Client) Request(v interface{}, method, path string, data interface{}) e
 
 	return errorResponse
 }
-
-// Balance returns the balance information for the account that is associated
-// with the access key.
-func (c *Client) Balance() (*Balance, error) {
-	balance := &Balance{}
-	if err := c.Request(balance, http.MethodGet, "balance", nil); err != nil {
-		return nil, err
-	}
-
-	return balance, nil
-}
-
-// HLR looks up an existing HLR object for the specified id that was previously
-// created by the NewHLR function.
-func (c *Client) HLR(id string) (*HLR, error) {
-	hlr := &HLR{}
-	if err := c.Request(hlr, http.MethodGet, HLRPath+"/"+id, nil); err != nil {
-		return nil, err
-	}
-
-	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, http.MethodGet, HLRPath, nil); err != nil {
-		return nil, err
-	}
-
-	return hlrList, nil
-}
-
-// NewHLR retrieves the information of an existing HLR.
-func (c *Client) NewHLR(msisdn string, reference string) (*HLR, error) {
-	requestData, err := requestDataForHLR(msisdn, reference)
-	if err != nil {
-		return nil, err
-	}
-
-	hlr := &HLR{}
-
-	if err := c.Request(hlr, http.MethodPost, HLRPath, requestData); err != nil {
-		return nil, err
-	}
-
-	return hlr, nil
-}
-
-// Message retrieves the information of an existing Message.
-func (c *Client) Message(id string) (*Message, error) {
-	message := &Message{}
-	if err := c.Request(message, http.MethodGet, MessagePath+"/"+id, nil); err != nil {
-		return nil, err
-	}
-
-	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, http.MethodGet, MessagePath+"?"+params.Encode(), nil); err != nil {
-		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) {
-	requestData, err := requestDataForMessage(originator, recipients, body, msgParams)
-	if err != nil {
-		return nil, err
-	}
-
-	message := &Message{}
-	if err := c.Request(message, http.MethodPost, MessagePath, requestData); err != nil {
-		return nil, err
-	}
-
-	return message, nil
-}
-
-// MMSMessage retrieves the information of an existing MmsMessage.
-func (c *Client) MMSMessage(id string) (*MMSMessage, error) {
-	mmsMessage := &MMSMessage{}
-	if err := c.Request(mmsMessage, http.MethodGet, MMSPath+"/"+id, nil); err != nil {
-		return nil, err
-	}
-
-	return mmsMessage, nil
-}
-
-// NewMMSMessage creates a new MMS message for one or more recipients.
-func (c *Client) NewMMSMessage(originator string, recipients []string, msgParams *MMSMessageParams) (*MMSMessage, error) {
-	params, err := paramsForMMSMessage(msgParams)
-	if err != nil {
-		return nil, err
-	}
-
-	params.Set("originator", originator)
-	params.Set("recipients", strings.Join(recipients, ","))
-
-	mmsMessage := &MMSMessage{}
-	if err := c.Request(mmsMessage, http.MethodPost, MMSPath, params); err != nil {
-		return nil, err
-	}
-
-	return mmsMessage, nil
-}
-
-// VoiceMessage retrieves the information of an existing VoiceMessage.
-func (c *Client) VoiceMessage(id string) (*VoiceMessage, error) {
-	message := &VoiceMessage{}
-	if err := c.Request(message, http.MethodGet, VoiceMessagePath+"/"+id, nil); err != nil {
-		return nil, err
-	}
-
-	return message, nil
-}
-
-// VoiceMessages retrieves all VoiceMessages of the user.
-func (c *Client) VoiceMessages() (*VoiceMessageList, error) {
-	messageList := &VoiceMessageList{}
-	if err := c.Request(messageList, http.MethodGet, VoiceMessagePath, nil); err != nil {
-		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) {
-	requestData, err := requestDataForVoiceMessage(recipients, body, params)
-	if err != nil {
-		return nil, err
-	}
-
-	message := &VoiceMessage{}
-	if err := c.Request(message, http.MethodPost, VoiceMessagePath, requestData); err != nil {
-		return nil, err
-	}
-
-	return message, nil
-}
-
-// NewVerify generates a new One-Time-Password for one recipient.
-func (c *Client) NewVerify(recipient string, params *VerifyParams) (*Verify, error) {
-	requestData, err := requestDataForVerify(recipient, params)
-	if err != nil {
-		return nil, err
-	}
-
-	verify := &Verify{}
-	if err := c.Request(verify, http.MethodPost, VerifyPath, requestData); err != nil {
-		return nil, err
-	}
-
-	return verify, nil
-}
-
-// VerifyToken performs token value check against MessageBird API.
-func (c *Client) VerifyToken(id, token string) (*Verify, error) {
-	params := &url.Values{}
-	params.Set("token", token)
-
-	path := VerifyPath + "/" + id + "?" + params.Encode()
-
-	verify := &Verify{}
-	if err := c.Request(verify, http.MethodGet, path, nil); err != nil {
-		return nil, err
-	}
-
-	return verify, nil
-}
-
-// Lookup performs a new lookup for the specified number.
-func (c *Client) Lookup(phoneNumber string, params *LookupParams) (*Lookup, error) {
-	urlParams := paramsForLookup(params)
-	path := LookupPath + "/" + phoneNumber + "?" + urlParams.Encode()
-
-	lookup := &Lookup{}
-	if err := c.Request(lookup, http.MethodPost, path, nil); err != nil {
-		return nil, err
-	}
-
-	return lookup, nil
-}
-
-// NewLookupHLR creates a new HLR lookup for the specified number.
-func (c *Client) NewLookupHLR(phoneNumber string, params *LookupParams) (*HLR, error) {
-	requestData := requestDataForLookup(params)
-	path := LookupPath + "/" + phoneNumber + "/" + HLRPath
-
-	hlr := &HLR{}
-	if err := c.Request(hlr, http.MethodPost, path, requestData); err != nil {
-		return nil, err
-	}
-
-	return hlr, nil
-}
-
-// LookupHLR performs a HLR lookup for the specified number.
-func (c *Client) LookupHLR(phoneNumber string, params *LookupParams) (*HLR, error) {
-	urlParams := paramsForLookup(params)
-	path := LookupPath + "/" + phoneNumber + "/" + HLRPath + "?" + urlParams.Encode()
-
-	hlr := &HLR{}
-	if err := c.Request(hlr, http.MethodGet, path, nil); err != nil {
-		return nil, err
-	}
-
-	return hlr, nil
-}